use case
Advanced Playground
OPFS 上に docs site の原稿と設定を保存し、ブラウザだけで編集・書き出しし、必要なら WebMCP からも操作するための実装プラン。
documentation site foundation
Papyr は、Markdown から育てるドキュメントサイトの土台です。
原稿は Markdown のまま扱い、公開側では目次、検索、raw Markdown、slide view をまとめて提供します。 読む人が今いる場所を見失わない docs site を作るための実装例です。
- まず読む場所が分かる 入口、手順、リファレンス、更新情報を分け、読み始めの迷いを減らします。
- Markdown を隠さない 公開ページから原文 Markdown へ戻れるので、読む人も書く人も同じ情報を確認できます。
- 目次と検索で戻れる 長い book でも章目次と全文検索を残し、読み直しやすい形にします。
use cases
実例から読む
公開、authoring、Cloudflare 配信など、複数 package を組み合わせる場面から先に辿れます。
use case
Cloudflare で Papyr の公開サイトを組み立てる
Workers と Cloudflare storage を使って、PapyrDocument の公開導線を組む use case。
use case
Markdown リポジトリを Papyr docs pipeline に載せる
Markdown source を PapyrDocument に変換し、preview と search を載せた小さな docs pipeline を組む use case。
use case
Papyr の公式 docs site
Papyr で Papyr 自身の docs を構築する dogfooding use case。構成、導線、公開方法を実例として辿れます。
patterns
読みやすく保つための型
入口、章立て、検索、Markdown 導線をそろえて、長いドキュメントでも戻りやすくします。
pattern
入口ページで全体像を伝える
最初の画面で「何のためのサイトか」「誰向けか」「次に読む場所」を短く案内します。
pattern
手順と参照情報を分ける
導入ガイドは順番に読み進められる形にし、詳細は機能別ドキュメントへ分けて迷いを減らします。
pattern
章立てで検索しやすくする
記事、章、トピックを整理しておくと、探したい手順や背景説明に短時間でたどり着けます。
pattern
図・表・コードで理解を助ける
文章だけでなく、コード例、図解、表を使って、説明が長くなりやすい内容を読みやすく保てます。
getting started
次にやることを選べます
初めて触る人向けの導線を 3 つに絞り、読む・試す・詳しく調べるのどれからでも始められます。
docs
機能別ドキュメント
詳しく知りたいときは、最初に読むものと package ごとのリファレンスを分けて辿れます。
📋
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-cloudflare
Cloudflare Workers 向けの BackendAdapter 実装。KV / D1 / R2 の 3 戦略から選択。
cloudflareadapter
💾
Package
@f12o/papyr-adapter-fs
PapyrDocument をローカル JSON ファイルへ保存する BackendAdapter。
backendfs
updates
最新の更新情報
リリースや公開内容の変化を追いたいときは、ここから最新の記事を確認できます。
-
🎉
Article
@papyr の公式ドキュメントサイトを公開しました
@papyr のドキュメントを @papyr 自身で作り、Cloudflare Workers にデプロイしました。
releasedocs -
🛠️
Article
CI で Markdown を自動整形する @f12o/papyr-markdown-formatter
@f12o/papyr-markdown-formatter を使うと、Papyr のブロック構造を壊さずに Markdown を正規化できます。Node.js スクリプトから呼び出して CI に組み込めます。
cimarkdownformatter -
🧭
Article
Moonlight block で authoring flow を残す
papyr-moonlight フェンスを使って、Papyr の authoring / preview / regression 確認に使える設計メモを公開 docs に置く例。
authoringpreviewmoonlightregression