Parchment

Qu'est-ce que Parchment ?

Parchment est un SaaS simple, « alternative à Notion », conçu pour créer et organiser des pages et collections indépendantes. Il offre une interface claire centrée sur l'organisation du contenu en pages, les collections servant de regroupements.

Une fonctionnalité majeure de Parchment est l'accès programmatique : vous pouvez gérer les collections, pages et blocs via une API. Cela s'adresse aux utilisateurs souhaitant un contenu de page structuré, créable, modifiable et exportable par code.

Fonctionnalités principales

• Collections et pages (gérées via actions API) : Créer, renommer, lister et supprimer collections et pages pour contrôler la structure programmatiquement.
• Contenu de page par blocs : Les pages sont composées de blocs ordonnés (ex. : titres, texte, listes, code, séparateurs) que vous pouvez ajouter ou remplacer.
• Réécriture complète de page avec replace_blocks : replace_blocks supprime tous les blocs existants et écrit un nouveau tableau dans l'ordre — idéal pour générer une page complète depuis zéro.
• Éditions incrémentales avec append_blocks : append_blocks ajoute des blocs en fin de page sans remplacer le contenu existant, pour des workflows additifs.
• Listes imbriquées avec indent_level : Les blocs bullet_list et numbered_list acceptent un entier indent_level (0–4) pour représenter l'imbrication des listes.
• Formatage de blocs basé sur HTML : Le contenu des blocs est stocké en chaînes HTML ; formats supportés : gras, italique, barré, liens et texte coloré via balises HTML standard.
• Blocs de groupe (group / delete_group) : Un bloc de groupe sert de conteneur pour des blocs enfants ; créez le groupe, associez les enfants via group_id, et supprimez le groupe (et enfants) en une opération.
• Types de blocs définis : Inclut text, heading1/2/3, bullet_list, numbered_list, todo, quote, divider, code et group.

Comment utiliser Parchment

1. Créez une clé API et envoyez des requêtes à l'URL de base de l'API : https://theparchment.app/functions/v1/api.
2. Lister ou créer la structure : Commencez par lister les collections (list_collections), puis créez collections et pages avec les actions correspondantes (ex. : create_collection, create_page).
3. Écrivez le contenu de page avec des blocs : Utilisez append_blocks pour ajouter des blocs en fin de page existante, ou replace_blocks pour réécrire toute la page en une seule requête.
4. Formatez le contenu avec des chaînes HTML : Fournissez le content de chaque bloc en chaîne HTML avec balises supportées (ex. : liens via <a href="...">...</a>).
5. Organisez avec des groupes si besoin : Créez d'abord un bloc group, puis ajoutez des blocs enfants référencés par group_id ; supprimez le contenu lié via delete_group.

Cas d'usage

• Générer des pages à partir de données structurées : Utilisez replace_blocks pour écrire une mise en page complète (titres, séparateurs, paragraphes, listes) depuis une source unique.
• Construire des logs de documentation « append-only » : Utilisez append_blocks pour ajouter sections, mises à jour ou entrées en fin de page sans perturber le contenu antérieur.
• Maintenir des listes de vérification hiérarchiques : Créez des blocs todo (éléments à cocher) et utilisez des blocs bullet_list/numbered_list imbriqués avec indent_level pour sous-tâches ou plans.
• Gérer des blocs de contenu templatisés sur plusieurs pages : Créez et renommez programmatiquement des pages, puis insérez des séquences de blocs cohérentes (incluant extraits de code via code).
• Créer des sections réutilisables via groupement : Utilisez des blocs de groupe pour regrouper des blocs liés, et supprimez ou régénérez une section entière avec delete_group.

FAQ

• Quelle est l'URL de base de l'API Parchment ? L'URL de base de l'API est https://theparchment.app/functions/v1/api.

• Comment authentifier les requêtes ? Toutes les requêtes nécessitent un en-tête x-api-key. Les exemples de documentation montrent x-api-key: pmt_your_key.

• Quelle est la différence entre append_blocks et replace_blocks ? append_blocks ajoute de nouveaux blocs en fin de page sans remplacer les existants, tandis que replace_blocks supprime tous les blocs existants et écrit les blocs fournis dans l'ordre du tableau.

• Le contenu des blocs est-il en texte brut ou HTML ? Le contenu des blocs est stocké en chaînes HTML ; le formatage utilise des balises HTML standard (ex. : <strong>, <i>, <a> et <span style="color: ...">).

• Comment fonctionnent les listes imbriquées ? Pour bullet_list et numbered_list, les blocs supportent un champ indent_level (entier 0–4) pour représenter les sous-listes imbriquées.

Alternatives

• Autres outils de documentation ou base de connaissances avec API : Si vous devez générer ou mettre à jour des pages structurées via code, cherchez des outils offrant des API blocs/pages similaires au modèle collection/page/bloc.
• Plateformes wiki/documentation généralistes : Elles supportent hiérarchies de pages et templates, mais le workflow et le modèle de données peuvent différer (surtout sans tableaux de blocs).
• Approches génériques base de données vers pages : Les outils rendant du contenu de base de données en pages conviennent pour l'organisation structurée, mais n'offrent pas toujours les mêmes sémantiques append/remplace au niveau bloc.
• Générateurs de sites statiques locaux : Pour équipes à l'aise avec génération au moment du build, ces outils produisent des pages cohérentes depuis templates, mais sans modèle d'édition interactif via API SaaS.