MkDocs

Markdownとプロジェクトドキュメント。


MkDocsは、プロジェクトドキュメントを作成することに特化した、高速シンプル実にゴージャスな静的サイトジェネレーターです。ドキュメントソースファイルはMarkdownで記述され、単一のYAML構成ファイルで構成されています。まず、入門チュートリアルを読んで、さらに詳しい情報についてはユーザーガイドをご覧ください。

機能

素晴らしいテーマが提供されています

MkDocsには、見栄えのテーマがたくさんあります。組み込みのテーマであるmkdocsreadthedocsから選択するか、サードパーティのテーマ(MkDocs Themes wikiページとMkDocs Catalogにあります)の1つを選択するか、独自に構築します。

簡単カスタマイズ

テーマをカスタマイズしたり、プラグインをインストールしたりして、プロジェクトドキュメントを好きなように見せることができます。Markdown拡張機能でMarkdownの動作を変更します。多くの構成オプションがあります。

作業中にサイトをプレビュー

組み込みの開発サーバーを使用して、ドキュメントを記述しているときにプレビューできます。変更を保存するたびに自動的に再読み込みとブラウザの更新が行われます。

どこでもホスティング

MkDocsは完全に静的なHTMLサイトを構築し、GitHub Pages、Amazon S3、または任意の場所にホストできます。