コンテンツへスキップ
Fumadocs

比較

Fumadocs は既存のフレームワークと何が違うのでしょうか?

Nextra

Fumadocs は Nextra から大きな影響を受けており、ルーティング規約などはその一例です。そのため、 Fumadocs にも meta.json が存在します。

Nextra は Fumadocs よりも設計方針が明確に定められています。その反面、 設定ファイルを編集するだけで済む Nextra とは異なり、Fumadocs では手動で設定を行う必要があります。

既存のコードベースへの導入や高度なルーティングの実装など、あらゆる部分を より細かく制御したい場合には、Fumadocs が最適です。

機能比較表

機能FumadocsNextra
静的生成対応対応
キャッシュ対応対応
ライト/ダークモード対応対応
シンタックスハイライト対応対応
目次対応対応
全文検索対応対応
i18n対応対応
Git の最終更新日時対応対応
ページアイコン対応対応 (_meta.js ファイルで設定)
RSC対応対応
リモートソース対応対応
SEOMetadata 経由で対応対応
組み込みコンポーネント対応対応
RTL レイアウト対応対応

その他の機能

TypeDoc などのサードパーティライブラリによって提供される機能は、ここには記載していません。

機能FumadocsNextra
OpenAPI 連携ありなし
TypeScript ドキュメント生成ありなし
TypeScript Twoslashありあり

Mintlify

Mintlify はドキュメントサービスです。Fumadocs とは異なり、無料プランはあるものの、完全に無料でもオープンソースでもありません。

Fumadocs は Mintlify ほど高機能ではありません。たとえば、Mintlify の OpenAPI 連携がその一例です。 Fumadocs の作者としては、現在のドキュメント作成方法に満足しているのであれば、Mintlify から Fumadocs への乗り換えはおすすめしません。 とはいえ、Fumadocs は洗練されたドキュメントを作りたいすべての React.js 開発者に適したツールだと考えています。

Docusaurus

Docusaurus は React.js をベースにした強力なフレームワークです。 プラグインやカスタムテーマを通じて、多くの便利な機能を利用できます。

複雑さが低い

Fumadocs は React フレームワークとの統合を前提に設計されているため、使い始めるには React.js についてある程度深い知識が必要になる場合があります。 その代わり、Fumadocs はカスタマイズ性に優れています。

シンプルなドキュメントで、フレームワーク固有の機能が不要な場合は、Docusaurus のほうが適しているかもしれません。

プラグイン

プラグインを使えば、多くのことを簡単に実現できます。実際、Docusaurus のエコシステムはより大規模で、多くのコントリビューターによってメンテナンスされています。

一方、Fumadocs は柔軟性が高いため同様の機能を自分で実装できますが、納得のいく形に仕上げるまでには時間がかかる場合があります。

How is this guide?