Parchment

Parchmentとは？

Parchmentは、スタンドアロンページとコレクションを作成・整理することを中心としたシンプルなSaaS「Notion代替」です。クリーンなUIを提供し、コンテンツをページに整理することを概念的に重視しており、コレクションはグループ化として機能します。

Parchmentの主な機能の一つはプログラムによるアクセスです。API経由でコレクション、ページ、ページ内のブロックを管理できます。これは、コードで構造化されたページコンテンツを作成・更新・エクスポートしたいユーザー向けです。

主な機能

• コレクションとページ（APIアクションで管理）: コレクションとページを作成、名前変更、一覧表示、削除して、コンテンツ構造をプログラムで制御。
• ブロックベースのページコンテンツ: ページは順序付けられたブロック（例: 見出し、テキスト、リスト、コード、区切り線）で構成され、追加や置換が可能。
• replace_blocksによるページ全体の書き換え: ページの既存ブロックをすべて削除し、新しい配列を順序通りに書き込みます。ゼロから完全なページを生成するのに便利。
• append_blocksによる増分的編集: ページの末尾にブロックを追加し、既存コンテンツを置き換えません。追加型ワークフローをサポート。
• indent_levelによるネストリスト: bullet_listおよびnumbered_listブロックはindent_level整数（0–4）を受け付け、ネストリストのレンダリングを表現。
• HTMLベースのブロックフォーマット: ブロックコンテンツはHTML文字列として保存。太字、斜体、取り消し線、リンク、色付きテキストなどの標準HTMLタグをサポート。
• グループブロック（group / delete_group）: グループブロックは子ブロックのコンテナとして機能。グループを作成後、group_idで子ブロックを関連付け、一度の操作でグループ（と子）を削除。
• 定義されたブロックタイプ: text、heading1/2/3、bullet_list、numbered_list、todo、quote、divider、code、groupを含む。

Parchmentの使い方

1. APIキーの作成し、APIベースURL https://theparchment.app/functions/v1/api にリクエストを送信。
2. 構造の一覧表示または作成: list_collectionsでコレクションを一覧表示し、対応アクション（例: create_collection、create_page）でコレクションとページを作成。
3. ブロックを使ってページコンテンツを記述: 既存ページの末尾にappend_blocksでブロックを追加、またはreplace_blocksでページ全体を1回の呼び出しで書き換え。
4. HTML文字列でコンテンツをフォーマット: 各ブロックのcontentをサポートタグ付きHTML文字列で提供（例: <a href="...">...</a>によるリンク）。
5. 必要に応じてグループで整理: まずgroupブロックを作成し、group_idで参照する子ブロックを追加。delete_groupで関連コンテンツを削除。

ユースケース

• 構造化データからページ生成: replace_blocksを使って単一の真実のソースから完全なページレイアウト（見出し、区切り線、段落、リスト）を記述。
• 「追加専用」ドキュメントログの構築: append_blocksでページ末尾に新セクション、更新、エントリを追加し、既存コンテンツを妨げない。
• 階層チェックリストの維持: todoブロック（チェックボックス項目）を作成し、indent_level付きネストbullet_list/numbered_listブロックでサブタスクやアウトラインを表現。
• 複数ページにわたるテンプレートコンテンツブロックの管理: ページをプログラムで作成・名前変更し、codeブロックタイプ経由で一貫したブロックシーケンス（コードスニペット含む）を挿入。
• グループによる再利用セクション作成: 関連ブロックをグループブロックでまとめ、delete_groupでセクション全体を削除または再生成。

FAQ

• Parchment APIのエンドポイントは？ APIベースURLはhttps://theparchment.app/functions/v1/apiです。

• リクエストの認証方法は？ すべてのリクエストにx-api-keyヘッダーが必要。ドキュメント例ではx-api-key: pmt_your_keyを示します。

• append_blocksとreplace_blocksの違いは？ append_blocksは既存ブロックを置き換えずにページ末尾に新ブロックを追加。一方、replace_blocksは既存ブロックをすべて削除し、提供配列順にブロックを記述。

• ブロックコンテンツはプレーンテキストかHTMLか？ ブロックコンテンツはHTML文字列として保存。フォーマットは標準HTMLタグ（例: <strong>、<i>、<a>、<span style="color: ...">）を使用。

• ネストリストの仕組みは？ bullet_listおよびnumbered_listブロックはindent_levelフィールド（整数0–4）をサポートし、ネストサブリストを表現。

代替品

• API付き他のドキュメント/ナレッジベースツール: コード経由で構造化ページを生成・更新する場合、コレクション/ページ/ブロックモデルに似たブロック/ページAPIを提供するツールを探す。
• 汎用ウィキ/ドキュメントプラットフォーム: ページ階層とテンプレートをサポートするが、ワークフローとデータモデルが異なる（特にブロック配列を使わない場合）。
• 汎用データベース-to-ページアプローチ: 構造化整理が主目的の場合、データベースからページにコンテンツをレンダリングするツールが適合。ただし、同じブロックレベル追加/置換セマンティクスを提供しない可能性。
• ローカル静的サイトジェネレータ: ビルド時生成に慣れたチーム向け。テンプレートから一貫したページを生成するが、SaaS API経由のインタラクティブページ編集モデルを通常サポートしない。