🚀
Getting Started
Getting Started
@papyr を最短で触るための導入ガイド。インストール、最初のドキュメント、backend 接続、Playground まで。
getting-startedoverview
books
読む順番で辿る docs
Getting Started、代表 use case、package docs の順に並べ、詳しい use case 一覧は専用ページへ分けています。
recommended order
おすすめの読み順
初見ならこの順番で読むと、中心モデルから周辺 package まで段階的に追えます。
step 1
core と markdown から始める PapyrDocument と Markdown 変換の基礎を先に押さえると、他の package の役割が追いやすくなります。step 2
CLI / formatter / editor-ui を足す 変換フロー、整形、headless editor layer、編集 UI など、実際の authoring 作業に近い layer を次の段階で追加します。step 3
backend と adapter は必要になってから読む 保存先や公開構成は用途依存なので、全体像を掴んだあとで backend と adapter 群へ進むのが分かりやすいです。start here
最初に読む
導入の流れを追って、Papyr の中心モデルを先に掴みます。
use cases
実例の入口
代表的な use case だけを入口として置き、一覧は /use-cases で辿ります。
use-case index
/use-cases で実例を選ぶ
5 件の use case を、用途別の一覧ページで確認できます。/books では読む順番を保つため代表例だけを置いています。
recommended
Advanced Playground
OPFS 上に docs site の原稿と設定を保存し、ブラウザだけで編集・書き出しし、必要なら WebMCP からも操作するための実装プラン。
example
Cloudflare で Papyr の公開サイトを組み立てる
Workers と Cloudflare storage を使って、PapyrDocument の公開導線を組む use case。
example
Markdown リポジトリを Papyr docs pipeline に載せる
Markdown source を PapyrDocument に変換し、preview と search を載せた小さな docs pipeline を組む use case。
core packages
中心モデルと変換
PapyrDocument、Markdown 変換、preview、search など中核レイヤを参照します。
🪵
Package
@f12o/papyr-core
ドキュメントモデル、ブロックスキーマ、レンダラーインターフェースの土台パッケージ。
coremodel
📝
Package
@f12o/papyr-markdown
Markdown と PapyrDocument の相互変換。papyr-table / papyr-moonlight / mermaid フェンス対応。
markdown
👀
Package
@f12o/papyr-preview
PapyrDocument をブラウザや WebView でそのまま描画する preview renderer。
previewrenderer
🔎
Package
@f12o/papyr-search
クライアントサイド全文検索。既定は MiniSearch、SearchAdapter で差し替え可能。
search
🗄️
Package
@f12o/papyr-backend
バックエンドアダプタのインターフェース。list / get / put / delete と optional search を揃える土台。
backendadapter
authoring
編集と authoring
CLI、editor、editor-ui、VS Code extension、formatter をまとめて辿れます。
🛠️
Package
@f12o/papyr-cli
Markdown と Papyr JSON を相互変換する Node.js CLI。
climarkdown
✍️
Package
@f12o/papyr-editor
TipTap ベースのヘッドレスエディタ拡張。リスト項目に任意ブロックを入れられる papyr schema に対応。
editortiptap
🪟
Package
@f12o/papyr-editor-ui
Papyr の visual React editor workspace を提供する UI package。
editorreactui
🧰
Package
papyr-vscode-extension
Papyr Markdown を custom editor で開く VS Code extension。
vscodeeditor
✨
Package
@f12o/papyr-markdown-formatter
Papyr が表現できる Markdown subset を parse -> serialize で正規化する formatter。
markdownformatter
publishing
公開と adapter
publish path と保存先 adapter、Cloudflare demo を用途別に参照します。
☁️
Package
@f12o/papyr-demo-cloudflare
article / book / chapter 対応の publishing SPA デモ。
cloudflaredemo
💾
Package
@f12o/papyr-adapter-fs
PapyrDocument をローカル JSON ファイルへ保存する BackendAdapter。
backendfs
📋
Package
@f12o/papyr-adapter-airtable
Airtable base / table へ PapyrDocument を保存する BackendAdapter。
backendairtable
📱
Package
@f12o/papyr-adapter-appsheet
AppSheet table へ PapyrDocument を保存する BackendAdapter。
backendappsheet
🧩
Package
@f12o/papyr-adapter-kintone
kintone アプリへ PapyrDocument を保存する BackendAdapter。
backendkintone
☁️
Package
@f12o/papyr-adapter-cloudflare
Cloudflare Workers 向けの BackendAdapter 実装。KV / D1 / R2 の 3 戦略から選択。
cloudflareadapter
🏬
Package
@f12o/papyr-adapter-zoho-creator
Zoho Creator の form / report へ PapyrDocument を保存する BackendAdapter。
backendzoho