コンテンツにスキップ

Mkdocsとは!?

MkDocsは、高速でシンプルかつ実にゴージャスな静的サイトジェネレーター(Static Site Generator)です。

静的サイトジェネレータとは、何らかの言語で記述したコードから、HTML/CSS/JavaScriptによる静的なウェブサイトを生成するツールのことです。

静的ジェネレータの利点は、表示速度、セキュリティ、SEOといった点が挙げられます。

ドキュメントのソースファイルはMarkdownで記述され、単一のYAML構成ファイルで構成されます。

ここで、Mkdocsを説明するためには、まずMarkdownという言葉が出てきますので、その言葉を先に説明しておきます。

Markdownとは

Markdown(マークダウン)は、テキストにメモする要領で簡単に書ける記法です。

<特徴>

  • pythonで開発された静的サイトジェネレータ
  • 簡単に環境が構築できる
  • 記事がマークダウンで記載できるため簡単で覚えやすい
  • 文章の構造を明示できる
  • 読み書きに特別なアプリを必要としない
  • HTMLに変換しやすい
  • Mkdocsを使って自動的に見映えの良い静的サイトが生成できる

Mkdocsが使いやすい点

  • 誰でも簡単に覚えられるMarkdownの記法でHTMLが作成できる!
  • 生成されたHTMLサイトが非常に軽快に動作する!
  • Googleアナリティクスと連携するだけでサイト解析ができるようになる!
  • 設定ファイルを変更するだけで全ページに設定が適用される!
  • GitHubやAzure DevOps Repos/Pipelinesと相性が良い!
  • Azure WebAppsと連携すると自動的にHTMLサイトにコンテンツを反映させるようにできる!

以上のように、MarkdownとMkdocsは、使いやすい点が多くあり、自分でブログサイトを作るのにも非常に良いです。

是非皆さん使ってみて、Mkdocsの良さを体感してください。

現状、利用されている方が技術情報を日々アップしてくださっていますが、 公式サイトは英語情報のみであるため、日本語での技術情報が不足しています。

その辺りの情報が充実してくると助かります!!!


参考サイト