Lotus スターター
MDX ページ、セクションナビゲーション、ページ内目次を備えた Astro のドキュメント用スターター。コンテンツをリポジトリで管理し、製品に合うサイトにカスタマイズできます。
src/content/docs/overview.mdx
製品ドキュメント
製品の進化に、ドキュメントも追いつく。
Starlight・Fumadocs・Lotus・Dahlia のドキュメントサイトで使える Git ベース CMS。ガイド、対応するコンポーネント、ページ属性、ナビゲーションを編集し、差分を確認して公開できます。
選んだドキュメントサイトを、使い続ける。
Lotus、Starlight、Fumadocs、Dahlia の公式ドキュメントサイトをご覧ください。テンプレートから始めても、テーマやビルドの仕組みは変えずに、チームでコンテンツを編集できます。
Starlight スターター
ガイドとリファレンスのセクションを備えた Astro のドキュメント用スターター。Markdown・MDX とドキュメント用コンポーネントで、豊かなページを作れます。
src/content/docs/guides/example.mdx
Fumadocs スターター
Create Fumadocs で生成するドキュメント用スターター。MDX でページを書き、アプリがナビゲーションと読むためのレイアウトを提供します。
content/docs/index.mdx
Dahlia スターター
画面の高さ全体を使うナビゲーション、Markdown・MDX ページ、ページ内目次を備えた Astro のドキュメント用スターター。コンテンツとナビゲーション設定をリポジトリに置いたまま、自分の製品向けにカスタマイズできます。
src/content/docs/index.mdx
スクリーンショットは各プロジェクトの公式ドキュメントサイトです。ご自身のサイトは、テンプレートのリンクから作成できます。編集と標準ナビゲーションの対応範囲は、プロジェクトの設定によって異なります。
ドキュメントの更新も、日々の仕事に。
製品は、ひとつひとつの変更で進化します。その変化をよく知る人が、いつものレビューの流れで説明を更新できる場所を。
同じガイドを一緒に書く
文書と対応する属性を共同編集。通常の本文はビジュアル編集し、Markdown・MDX の全体はソースで開けます。
ページを見つけやすく
対応する Starlight、Fumadocs、Lotus、Dahlia の構成では、標準ナビゲーションとの関連付けを確認し、書き込み可能な既存のグループ内でページを整理できます。
関連する差分をまとめて確認
本文とナビゲーションの変更を一度に確認。コミットで公開することも、プルリクエストでチームの GitHub レビューにつなぐこともできます。
Prosefly で書く。ドキュメントサイトはそのまま。
Markdown と対応する MDX コンポーネントを、属性と並べてビジュアル編集。確認したファイルを公開すると、ドキュメントサイトが表示を引き継ぎます。
Prosefly の実際のビジュアル編集デモです。上の画像は、各フレームワークの公式ドキュメントサイトです。
ガイドの置き場所も、ナビゲーションで。
対応するナビゲーションとの関連付けを確認すると、エディターの Navigation パネルから、書き込み可能な既存のグループ内でページを整理できます。本文と配置を同じ流れで編集できます。
ドキュメントのナビゲーションについて
ガイドとナビゲーションを、まとめて確認。
公開前に、変更した文書とナビゲーション設定を一度に確認できます。確認したファイルをコミットまたはプルリクエストで公開し、既存のビルドでサイトを更新します。
公開ガイドを読む
次の下書きから、ウェブサイトへ。
- 01
ドキュメントを取り込む
GitHub を接続し、リポジトリをスキャン。docs コレクションと対応するナビゲーションとの関連付けを確認します。
- 02
チームでガイドを更新
本文と属性を編集し、ナビゲーションの配置を確認。未公開の作業はコンテンツスペースの下書きに保存します。
- 03
ファイルを確認して公開
差分を確認し、Git に公開。ドキュメントサイトは、いつもどおり更新されたリポジトリからビルドされます。
実際の使い方と対応範囲
ナビゲーション編集には、対応する標準設定との関連付けの確認が必要です。動的な構成や判定できない構成では、本文のみの公開が必要になることがあります。ナビゲーション項目を移動しても文書ファイルは移動しません。サイトのビルドやデプロイは Prosefly では行いません。
コンテンツが変わっても、所有権はそのまま。
公開した Markdown、MDX、データファイルは、自分のリポジトリに残ります。公開するまで下書きは Prosefly に保存されます。ライブラリにアップロードしたメディアは別途ホスティングされ、URL で参照します。
コンテンツの所有権についてサイトを支えるツールは、そのまま。
フレームワークやドキュメントツールごとの、コンテンツの扱い方をご覧ください。
Prosefly のほかの活用方法
今あるコンテンツで試してみましょう。
リポジトリを接続し、コレクションを確認して、1ページから始められます。