ナビゲーション
サイドバーのページを整理したり、外部リソースへのリンクを追加したり、ドキュメントを複数のバージョンで公開したりする方法を説明します。
概要
Fumadocs UI には、コンテンツを表示するためのさまざまなレイアウトが用意されています。ナビゲーションの設定はレイアウトで指定できます。
レイアウトのリンク
レイアウトに ナビゲーションリンク を表示します。
ショーケースや料金ページなど、よく使うリソースへのリンクを置くのに便利です。
サイドバーの項目
サイドバーには、すべてのドキュメントページへのリンクがレンダリングされます。
内部的には、ナビゲーション構造の表現に ページツリー が使われています。
バージョン管理
古いリリースのドキュメントが必要な読者のために、複数のバージョンを公開しておくことができます。バージョンを同じサイトで共有するか、バージョンごとに個別にデプロイするかを選択してください。
| 方法 | 適したケース |
|---|---|
| ルートタイプ | ドキュメントの一部だけをバージョン管理し、各バージョンを同じサイト内に置く場合 |
| 完全なバージョン管理 | Web サイト全体をバージョン管理し、バージョンごとに個別にデプロイする場合 |
ルートタイプ
バージョンごとにフォルダーを作成し、meta.json でそれぞれを同じタイプのルートフォルダーとして指定します。
{
"title": "1.0.0",
"root": "version"
}サイドバーには開いているバージョンのコンテンツのみが表示され、Docs レイアウトにはバージョンを切り替えるためのドロップダウンがレンダリングされます。各バージョンは title で表示されます。
切り替えても現在の位置は保持され、別のバージョンの同じページに移動します。そのページが存在しない場合は、そのバージョンのインデックスページに移動します。
| ページ | 2.0.0 に切り替えた場合 |
|---|---|
/docs/v1/getting-started | /docs/v2/getting-started |
/docs/v1/legacy-api | /docs/v2(インデックスページ) |
補足
タイプ名("version")には任意の値を指定できます。この値はタイプを識別するためだけに使われ、同じ親の下にある同じ
タイプのルートフォルダー同士は、互いに切り替えることができます。
完全なバージョン管理
https://v14.fumadocs.dev (Fumadocs v14) や https://fumadocs.dev (最新の Fumadocs) のように、Web サイト全体をバージョン管理したい場合もあります。
ドキュメントのバージョンごとに Git ブランチを作成し (例: v2)、v2.my-site.com のような別のサブドメインに独立したアプリとしてデプロイできます。
必要に応じて、ドキュメントから他のバージョンへのリンクを設置することもできます。 この方式には、部分的なバージョン管理と比べて次のような利点があります。
- メンテナンスが容易: 開発を進めたり依存関係をアップグレードしたりしても、古いドキュメントやブランチには影響しません。
- 一貫性の向上: ドキュメント自体だけでなく、ランディングページ (およびその他のページ) もバージョン管理されます。
How is this guide?
最終更新日
