MkDocs は、ドキュメント ウェブサイトの構築用に設計された静的サイト ジェネレータです。Python プログラミング言語で書かれた MkDocs は、コミュニティから大きな支持を得ているオープンソース プロジェクトです。テーマが数多く利用可能です。Markdown のサポートの観点から言うと、MkDocs は基本構文エレメントのサポートに優れていますが、一部の拡張構文エレメントのサポートはありません。
このアプリケーションは、Python-Markdown Markdown プロセッサを使用します。追加の拡張機能を有効にすることができます。
MkDocs Markdown のサポート
MkDocs は、以下の Markdown エレメントをサポートしています。
| エレメント | サポート | 注意 |
|---|---|---|
| 見出し | はい | |
| 段落 | はい | |
| 改行 | はい | |
| 太字 | はい | |
| 斜体 | はい | |
| 引用文 | はい | |
| 順序付きリスト | はい | |
| 順序なしリスト | はい | |
| コード | はい | |
| 水平線 | はい | |
| リンク | はい | |
| 画像 | はい | |
| 表 | はい | |
| フェンスコードブロック | はい | |
| 構文の強調表示 | はい | |
| 脚注 | いいえ | |
| 見出し ID | いいえ | |
| 定義リスト | いいえ | |
| 取り消し線 | いいえ | |
| タスク リスト | いいえ | |
| 絵文字（コピーアンドペースト） | 不明 | |
| 絵文字（ショートコード） | 不明 | |
| ハイライト | いいえ | |
| 下付き文字 | いいえ | |
| 上付き文字 | いいえ | |
| 自動 URL リンク | はい | |
| 自動 URL リンクの無効化 | はい | |
| HTML | はい |
注意の使用
便利な機能があります。MkDocs で注意を使用する拡張機能を有効にすることができます。これは、MkDocs サイトで注記、警告、およびヒントを簡単に使用するためのクイックかつ簡単な方法です。詳細情報と例については、この GitHub の問題をご覧ください。
参照
Markdown のスキルを次のレベルに引き上げます。
60 ページで Markdown を学べます。初心者にも専門家にも適した『The Markdown Guide』は、Markdown 構文の習得に役立つ包括的なリファレンス ブックです。
書籍を入手するMarkdown をさらに学習してみませんか？
今すぐ停止しないでください！🚀 GitHub リポジトリにスターを付け、メール アドレスを入力すると、新しい Markdown チュートリアルをメールで受け取ることができます。スパムではありません！