コンテンツへスキップ
Fumadocs

Fumadocs とは

自由に壊して作り変えられるドキュメントフレームワーク、Fumadocs をご紹介します。

Fumadocs フレームワークとは、UI + Core + コンテンツソースの組み合わせを指します。Fumadocs は具体的なフレームワークというよりも概念的な枠組みであり、各レイヤーはそれぞれ単独のライブラリとしても利用できます。

理念

Fumadocs は、より自由にカスタマイズできるドキュメント構築の体験を提供するために作られました。特定の設計思想を押し付けないドキュメントフレームワーク、つまり自由に壊せる「フレームワーク」を目指しています。

抽象化を最小限に

多くのフレームワークは設定ファイルで構成しますが、細部まで調整しようとすると柔軟性に欠けることがよくあります。 ページのレンダリング方法も内部ロジックも、自分で制御することはできません。

Fumadocs は設定ファイルに頼るのではなく、ユーザー自身がコードを書き、ソフトウェアの他の部分と連携させることを前提としています。アプリの動作の仕組みを明示しており、完全にカスタマイズできます。

シームレスな統合

Fumadocs はお使いの React フレームワークと緊密に統合され、便利なユーティリティと洗練された UI を提供します。

静的サイト生成 (Static Site Generation) など、フレームワークの機能はこれまでどおり利用できます。フレームワークの使い勝手は何も変わりません。

コンポーザブルな UI

Fumadocs UI(デフォルトのテーマ)が提供するのはユーザーインターフェースだけです。この UI は、モバイルでのレスポンシブ性とユーザー体験を高めるため、明確な設計方針に沿って作られています。

一方で、Shadcn UI に着想を得た、はるかに柔軟なアプローチも採用しています。Fumadocs CLI を使えば、Fumadocs UI の一部を「フォーク」して、自由にカスタマイズできます。

サーバーファーストのアプローチ

従来、静的サイトジェネレーターは静的なものでした。

しかし、Fumadocs は React サーバーコンポーネントを活用したサーバーファーストのアプローチを採用しています。 サーバーとクライアントの境界がきちんと分離されているため、コンテンツを動的かつインタラクティブにできます。

サーバーからデータを取得してコンテンツを表示したり、CMS と連携してリアルタイムに更新を反映したりできます。コンテンツは常に最新の状態に保たれ、メンテナンスも容易です。

ミニマル

Fumadocs は Fuma と多くのコントリビューターによってメンテナンスされており、コードベースの保守性を重視しています。

あらゆる要望に応える機能をすべて提供することは目指しておらず、基本的な機能を完璧に仕上げ、しっかりとメンテナンスすることに注力しています。 ぜひコントリビュートして、Fumadocs をさらに便利なものにするためにご協力ください!

Fumadocs を使うべき場面

Fumadocs は柔軟性を重視して設計されており、特定の用途に限定されません。

  • fumadocs-core は、ドキュメントを構築するためのヘッドレス UI ライブラリです。
  • fumadocs-mdx は、MDX コンテンツを扱うための便利なライブラリです。

ほとんどの Web アプリケーションにとって、素の React.js だけではもはや十分とはいえません。 最近では、ブログやショーケースページ、FAQ ページなども用意したくなるものです。このような場合、Fumadocs を使えば、ボイラープレートを減らして ドキュメントをより簡単に構築できます。

興味があれば、比較をご覧ください。

ドキュメント

Fumadocs は執筆体験を重視しており、美しいテーマと豊富なドキュメント自動化ツールを提供しています。

ドキュメントの更新を後回しにすることなく、コードベースをすばやく改善し続けられます。 このサイト自体も、Fumadocs で構築されたドキュメントサイトの一例です。

ブログサイト

ほとんどの React.js フレームワークは、それだけでブログサイトに必要な機能を十分に備えています。

Fumadocs は、シンタックスハイライト、ドキュメント検索、デフォルトテーマ (Fumadocs UI) などの追加ツールを提供します。 これにより、車輪の再発明を避けられます。

How is this guide?