他のフレームワークとの比較
Fumadocs は既存の他のフレームワークとどう違うのでしょうか?
Nextra
Fumadocs は Nextra から大きな影響を受けており、ルーティング規約もその一例です。そのため、
Fumadocs にも meta.json が存在します。
Nextra は Fumadocs よりも規約による制約が強く、その副作用として、 設定ファイルを編集するだけで済むのではなく、手動で設定しなければならない部分があります。
既存のコードベースへの組み込みや高度なルーティングの実装など、 あらゆる部分をより細かく制御したい場合は、Fumadocs が最適です。
機能比較表
| 機能 | Fumadocs | Nextra |
|---|---|---|
| 静的生成 | 対応 | 対応 |
| キャッシュ | 対応 | 対応 |
| ライト/ダークモード | 対応 | 対応 |
| シンタックスハイライト | 対応 | 対応 |
| 目次 | 対応 | 対応 |
| 全文検索 | 対応 | 対応 |
| i18n | 対応 | 対応 |
| Git の最終更新日時 | 対応 | 対応 |
| ページアイコン | 対応 | 対応 (_meta.js ファイルで設定) |
| RSC | 対応 | 対応 |
| リモートソース | 対応 | 対応 |
| SEO | メタデータで対応 | 対応 |
| 組み込みコンポーネント | 対応 | 対応 |
| RTL レイアウト | 対応 | 対応 |
その他の機能
TypeDoc などのサードパーティライブラリで実現できる機能は、ここには記載していません。
| 機能 | Fumadocs | Nextra |
|---|---|---|
| OpenAPI 連携 | あり | なし |
| TypeScript ドキュメント生成 | あり | なし |
| TypeScript Twoslash | あり | あり |
Mintlify
Mintlify はドキュメントサービスです。Fumadocs とは異なり、無料プランはあるものの、完全に無料でもオープンソースでもありません。
Mintlify の OpenAPI 連携などを見ると、Fumadocs は Mintlify ほど高機能ではありません。 Fumadocs の作者として言うと、現在のドキュメント構築方法に満足しているのであれば、Mintlify から Fumadocs への乗り換えはおすすめしません。 とはいえ、洗練されたドキュメントを作りたいすべての React.js 開発者にとって、Fumadocs は最適なツールだと考えています。
Docusaurus
Docusaurus は React.js をベースにした強力なフレームワークです。 プラグインやカスタムテーマを通じて、多彩な機能を利用できます。
導入のしやすさ
Fumadocs は React フレームワークとの統合を前提に設計されているため、使い始めるには React.js についてより深い知識が必要になる場合があります。 その分、Fumadocs はカスタマイズ性に優れています。
シンプルなドキュメントで、フレームワーク固有の機能が不要であれば、Docusaurus のほうが適しているかもしれません。
プラグイン
プラグインを使えば、多くのことを手軽に実現できます。Docusaurus のエコシステムは実際に規模が大きく、多くのコントリビューターによって支えられています。
一方、Fumadocs は柔軟性が高いため、こうした機能を自分で実装できます。ただし、満足のいく形に仕上げるまでには時間がかかる場合があります。
How is this guide?
最終更新日
