Parchment

Was ist Parchment?

Parchment ist ein simples SaaS „Notion-Alternative“, das auf der Erstellung und Organisation von Standalone-Seiten und Sammlungen basiert. Es bietet eine klare Benutzeroberfläche, die konzeptionell auf die Organisation von Inhalten in Seiten zentriert ist, wobei Sammlungen als Gruppierungen dienen.

Ein zentraler Bestandteil der Parchment-Funktionalität ist der programmgesteuerte Zugriff: Sie können Sammlungen, Seiten und die Blöcke in Seiten über eine API verwalten. Dies ist für Nutzer gedacht, die strukturierte Seiteninhalte erstellen, aktualisieren und exportieren möchten – per Code.

Wichtige Funktionen

• Sammlungen und Seiten (verwaltet über API-Aktionen): Erstellen, Umbenennen, Auflisten und Löschen von Sammlungen und Seiten, damit die Inhaltsstruktur programmgesteuert kontrolliert werden kann.
• Blockbasierte Seiteninhalte: Seiten bestehen aus geordneten Blöcken (z. B. Überschriften, Text, Listen, Code, Trennlinien), die Sie hinzufügen oder ersetzen können.
• Vollständige Seitenüberschreibungen mit replace_blocks: replace_blocks löscht alle vorhandenen Blöcke auf der Seite und schreibt ein neues Array in der Reihenfolge – nützlich zum Generieren einer vollständigen Seite von Grund auf.
• Inkrementelle Bearbeitungen mit append_blocks: append_blocks fügt Blöcke ans Ende einer Seite hinzu und ersetzt keinen bestehenden Inhalt – unterstützt additive Workflows.
• Verschachtelte Listen mit indent_level: bullet_list- und numbered_list-Blöcke akzeptieren eine Ganzzahl für indent_level (0–4), um verschachtelte Listen darzustellen.
• HTML-basierte Blockformatierung: Blockinhalte werden als HTML-Strings gespeichert; unterstützte Formatierungen umfassen Fettschrift, Kursiv, Durchgestrichen, Links und farbigen Text via Standard-HTML-Tags.
• Gruppenblöcke (group / delete_group): Ein Gruppenblock dient als Container für Kindblöcke; Sie erstellen die Gruppe, verknüpfen dann Kindblöcke mit group_id und können die Gruppe (inkl. Kinder) in einer Operation löschen.
• Definierte Blocktypen: Umfassen text, heading1/2/3, bullet_list, numbered_list, todo, quote, divider, code und group.

So verwenden Sie Parchment

1. Erstellen Sie einen API-Schlüssel und senden Sie Anfragen an die API-Basis-URL: https://theparchment.app/functions/v1/api.
2. Struktur auflisten oder erstellen: Beginnen Sie mit dem Auflisten von Sammlungen (list_collections), dann erstellen Sie Sammlungen und Seiten mit den entsprechenden Aktionen (z. B. create_collection, create_page).
3. Seiteninhalte mit Blöcken schreiben: Verwenden Sie append_blocks, um Blöcke ans Ende einer bestehenden Seite hinzuzufügen, oder replace_blocks, um die gesamte Seite in einem Aufruf zu überschreiben.
4. Inhalte mit HTML-Strings formatieren: Geben Sie den content-Wert jedes Blocks als HTML-String mit unterstützten Tags an (z. B. Links via <a href="...">...</a>).
5. Bei Bedarf mit Gruppierung organisieren: Erstellen Sie zuerst einen group-Block, fügen Sie dann Kindblöcke hinzu, die die Gruppe via group_id referenzieren; entfernen Sie verwandte Inhalte mit delete_group.

Anwendungsfälle

• Seiten aus strukturierten Daten generieren: Verwenden Sie replace_blocks, um ein vollständiges Seitenlayout (Überschriften, Trennlinien, Absätze, Listen) aus einer einzigen Wahrheit zu schreiben.
• „Append-only“-Dokumentationslogs erstellen: Nutzen Sie append_blocks, um neue Abschnitte, Updates oder Einträge ans Ende einer Seite anzuhängen, ohne vorherigen Inhalt zu stören.
• Hierarchische Checklisten pflegen: Erstellen Sie todo-Blöcke (Checkbox-Elemente) und verwenden Sie verschachtelte bullet_list/numbered_list-Blöcke mit indent_level für Unteraufgaben oder Gliederungen.
• Templatierte Inhaltsblöcke über mehrere Seiten verwalten: Erstellen und benennen Sie Seiten programmgesteuert, dann fügen Sie konsistente Blocksequenzen ein (inkl. Code-Snippets via code-Blocktyp).
• Wiederverwendbare Abschnitte via Gruppierung erstellen: Halten Sie verwandte Blöcke mit Gruppenblöcken zusammen und löschen oder regenerieren Sie einen gesamten Abschnitt mit delete_group.

FAQ

• Welchen Endpunkt verwendet die Parchment-API? Die API-Basis-URL lautet https://theparchment.app/functions/v1/api.

• Wie authentifiziere ich Anfragen? Alle Anfragen erfordern einen x-api-key-Header. Die Dokumentationsbeispiele zeigen x-api-key: pmt_your_key.

• Was ist der Unterschied zwischen append_blocks und replace_blocks? append_blocks fügt neue Blöcke ans Ende der Seite hinzu, ohne bestehende Blöcke zu ersetzen, während replace_blocks alle bestehenden Blöcke löscht und die angegebenen Blöcke in Array-Reihenfolge schreibt.

• Sind Blockinhalte reiner Text oder HTML? Blockinhalte werden als HTML-Strings gespeichert; Formatierungen nutzen Standard-HTML-Tags (z. B. <strong>, <i>, <a> und <span style="color: ...">).

• Wie funktionieren verschachtelte Listen? Bei bullet_list und numbered_list unterstützen Blöcke ein indent_level-Feld (Ganzzahl 0–4) für verschachtelte Unterlisten.

Alternativen

• Andere Dokumentations- oder Wissensdatenbank-Tools mit API: Wenn Sie strukturierte Seiten per Code generieren oder aktualisieren müssen, suchen Sie nach Tools mit Block-/Seiten-APIs ähnlich dem Sammlungs-/Seiten-/Block-Modell.
• Allgemeine Wiki-/Dokumentationsplattformen: Diese unterstützen Seitenhierarchien und Vorlagen, aber Workflow und Datenmodell können abweichen (besonders wenn sie keine Block-Arrays nutzen).
• Generische Datenbank-zu-Seiten-Ansätze: Tools, die Inhalte aus einer Datenbank in Seiten rendern, passen bei Fokus auf strukturierte Organisation, bieten aber möglicherweise nicht dieselben Block-spezifischen Append-/Replace-Semantiken.
• Lokale Static-Site-Generatoren: Für Teams, die mit Build-Time-Generierung vertraut sind, können Static-Site-Tools konsistente Seiten aus Vorlagen erzeugen, unterstützen aber typischerweise nicht dasselbe interaktive Seiten-Editierungsmodell via SaaS-API.