MkDocs
MkDocsは、Pythonで開発されたツールで、Markdownファイルに基づいて静的なドキュメントサイトを生成します。
概要概要
MkDocsは、巨大なコミュニティで非常に人気のあるツールです。ウェブサイトを作成するためのいくつかのテーマがあります。プログラムの基本機能とわかりやすいドキュメントを拡張するためのいくつかのplugins。
MkDocsは、Pythonで開発されたオープンソースプロジェクトです。
アプリケーションはMarkdown Python-Markdownプロセッサを使用して、基本構文要素の非常に優れたサポートを提供しますが、拡張構文の要素との互換性には少し不満があります。
MkDocsはPython-Markdownを使用するため、パーサーの動作を変更するために追加の拡張機能をアクティブ化できることに注意してください。利用可能で、Python-Markdownと互換性のある拡張機能のリストを表示するにはここをクリックしてください。
詳細については、MkDocs の公式Webサイトhttps://www.mkdocs.org/を参照してください。
MkDocsでのAdmonitionsの使用
Admonitions拡張機能を使用すると、MkDocsで作成されたWebサイトのページに定型化されたメッセージをユーザーに表示できます。
詳細と例については、GitHubのそのページを参照してください。
MkDocsでのMarkdownのサポート
表1.1は、MkDocsと互換性のあるMarkdown要素を示しています。
| 素子 | サポート | 情報 |
|---|---|---|
| タイトル | うん | |
| 段落 | うん | |
| 改行 | うん | |
| 大胆な | うん | |
| イタリック | うん | |
| Blockquote | うん | |
| 注文リスト | うん | |
| 順序付けられていないリスト | うん | |
| コード | うん | |
| 水平線 | うん | |
| Links | うん | |
| 画像 | うん | |
| テーブル | うん | |
| フェンスで囲まれたコードブロック | うん | ブロックコンテンツの構文を強調表示することができます。 |
| 脚注 | 番号 | |
| タイトルID | 番号 | |
| 定義リスト | 番号 | |
| 取り消し線 | 番号 | |
| タスクリスト | 番号 | |
| Emoji (コピーアンドペースト) | うん | デフォルトではサポートされていませんが、拡張機能を有効にしてこのMarkdown要素を使用できます。 |
| Emoji (アクセスコード) | うん | MkDocsはデフォルトでemoticonsコードをサポートしていませんが、このMarkdown要素を使用してコンテンツをフォーマットする拡張機能をインストールできます。 |
| URLの自動Link | うん | |
| URLの自動linkを無効にする | うん | |
| HTML | うん |