Fumadocs

Fumadocsは、開発者がReactとNext.jsを使ってプロフェッショナルなドキュメントサイトを構築するのを支援するドキュメンテーションフレームワークです。従来のドキュメントツールとは異なり、コンテンツとデザインを完全にコントロールできる一方で、複雑な部分は自動的に処理します。

MarkdownやMDXでのコンテンツ作成をサポートしており、シンプルなテキストフォーマットを使ったり、インタラクティブなReactコンポーネントを追加したりできます。フレームワークには組み込みの検索機能、構文ハイライト、美しいプリデザインテーマが含まれています。また、ファイル、データベース、コンテンツ管理システムなど、あらゆるコンテンツソースと連携可能です。

Fumadocsは、ドキュメント管理のためのコンテンツレイヤー、検索などの機能を提供するコアライブラリ、美しいコンポーネントを提供するUIライブラリの3つの部分で構成されています。必要なものだけを利用できます。

Fumadocsの始め方は簡単です。手順は以下の通りです：

• フレームワークをインストールするには、ターミナルでコマンドnpm create fumadocs-appを実行します。プロンプトが表示されたら、お好みのReactフレームワークとコンテンツソースを選択してください。

• コンテンツを書くには、docsフォルダ内のMDXファイルを使用します。シンプルなMarkdown構文を使い、インタラクティブな要素にはReactコンポーネントを追加できます。

• 外観をカスタマイズするにはTailwind CSSを使用します。新しいシステムを学ぶことなく、色、レイアウト、スタイルをブランドに合わせて変更可能です。

• 検索機能を追加するには、OramaまたはAlgoliaの検索を数行のコードで接続します。フレームワークが残りの処理を自動で行います。

• CLIツールを使うことで、タブ、コールアウト、コードブロックなどのインタラクティブなコンポーネントをコマンドnpx @fumadocs/cli addで追加できます。

• サイトをデプロイするには、Vercel、Netlify、またはNext.jsアプリケーションをサポートする任意のホスティングサービスを利用してください。

• 無料でオープンソースのフレームワーク

• Next.js、React Router、その他のReactフレームワークに対応

• MarkdownおよびMDXでコンテンツを作成

• OramaおよびAlgolia対応の組み込み検索機能

• OpenAPIドキュメントジェネレーター

• TypeScript Twoslash統合

• 美しいプリデザインUIコンポーネント

• 簡単セットアップのコマンドラインツール

• Shikiによる構文ハイライト

• Tailwind CSSによる高度なカスタマイズ性