mkdocs

MkDocs

Markdown を使用したプロジェクトのドキュメント

MkDocs は、プロジェクト ドキュメントの構築を目的とした、高速、シンプル、そして実にゴージャスな静的サイト ジェネレーターです。ドキュメントのソース ファイルは Markdown で記述され、単一の YAML 構成ファイルで構成されます。使いやすいように設計されており、サードパーティのテーマ、プラグイン、Markdown 拡張機能を使用して拡張できます。

入門チュートリアルと完全なユーザー ガイドについては、ドキュメントを参照してください。

特徴

• Markdown ファイルから静的 HTML ファイルを構築します。
• プラグインとマークダウン拡張機能を使用して MkDocs を強化します。
• 組み込みのテーマ、サードパーティのテーマを使用するか、独自のテーマを作成します。
• 静的ファイルを提供できる場所ならどこでもドキュメントを公開できます。
• もっともっと！

サポート

MkDocs についてサポートが必要な場合は、お気軽にお問い合わせください。

• 質問や高度なディスカッションについては、GitHub のディスカッションを使用してください。
  • 小さな質問については、Gitter/Matrix のチャット ルームを利用するのが良いでしょう。
• バグを報告したり、機能リクエストを行ったりするには、GitHub で問題を開きます。

MkDocs のコア機能に関する問題/質問に対してのみサポートを提供する場合があることに注意してください。サードパーティのテーマ、プラグイン、拡張機能などの機能に関する質問やバグレポートは、それぞれのプロジェクトに対して行う必要があります。
ただし、そのような質問はチャット ルームで禁止されていません。

いくつかの質問にも答えてください。

リンク

• 公式ドキュメント
• 最新のリリースノート
• サードパーティのプラグイン、テーマ、レシピのカタログ

MkDocs への貢献

MkDocs プロジェクトは、オープン ソース コミュニティの開発者やユーザーからの貢献を歓迎し、それに依存しています。ご協力いただける方法については、「貢献ガイド」をご覧ください。

行動規範

MkDocs プロジェクトのコードベース、問題追跡ツール、ディスカッション フォーラムでやり取りするすべての人は、PyPA 行動規範に従うことが期待されます。

ライセンス

BSD-2 条項