MkDocs

MkDocsは、Markdownファイルを完全な静的HTMLウェブサイトに変換するドキュメントジェネレーターです。コンテンツは誰でも数分で学べるシンプルなテキスト形式であるMarkdownで作成します。MkDocsはこれらのファイルを処理し、ナビゲーション、検索、美しいデザインを備えたフルサイトを生成します。

このツールには組み込みの開発サーバーがあり、入力しながらライブプレビューを表示します。つまり、ブラウザを手動で更新することなく、変更を即座に確認できます。MkDocsには2つの組み込みテーマがあり、人気のMaterial for MkDocsなど、多くのコミュニティ作成テーマもサポートしています。

MkDocsは静的ファイルを作成するため、ドキュメントは高速に読み込まれ、複雑なサーバー設定やデータベースを必要とせずにどこでもホスティング可能です。

MkDocsの始め方は簡単です：

• まだインストールしていない場合は、コンピュータにPythonをインストールしてください。MkDocsはPython 3.8以降が必要です。

• コマンド「pip install mkdocs」を使ってMkDocsをインストールします。これで必要なものがすべてダウンロード・設定されます。

• 「mkdocs new my-project」を実行して新しいプロジェクトを作成します。これにより、設定ファイルとサンプルドキュメントを含む基本構造のフォルダが作成されます。

• docsフォルダ内のMarkdownファイルにドキュメントを書きます。各ファイルがウェブサイトのページになります。

• 「mkdocs serve」を実行して作業内容をプレビューします。通常はhttp://127.0.0.1:8000でローカルサーバーが起動し、リアルタイムでドキュメントを確認できます。

• 「mkdocs build」を使って最終的なウェブサイトをビルドします。これにより、公開準備が整ったHTMLファイルが含まれるsiteフォルダが作成されます。

• ドキュメントをGitHub Pagesや任意のウェブホスティングサービスにデプロイします。GitHubの場合は「mkdocs gh-deploy」を使うか、siteフォルダの内容をアップロードしてください。

• Markdownベースのドキュメント作成

• 自動ブラウザ更新によるライブプレビュー

• 組み込みおよびサードパーティのテーマサポート

• 単一のYAML設定ファイル

• 拡張機能のためのプラグインシステム

• 高速な静的HTMLサイトを生成

• 外部サービス不要の統合検索機能

• どこでもデプロイ可能（GitHub Pages、Netlifyなど）

• オープンソースで完全無料

• 活発なコミュニティサポートと開発