MkDocsのHTMLをローカルで見るために

問題

htmlファイルをローカルで開いた状態で、他のMarkdown(から生成したhtml)ファイルへ飛ぼうとすると思った通りに飛ばない

具体的には以下のような表示になってしまう(下はpage_1に飛ぼうとした時の画像です。)

恐らく、Markdownから生成したページへのリンク指定がフォルダ下のindex.htmlではなくフォルダになっていることだと思われます。

index.htmlを省略した書き方は見た目はすっきりするんですが、ローカルで見る場合はindex.html を探す機能が働かず、ファイルの一覧が表示されてしまう。

解決策

下記サイトに書かれていました。

kojion.com

stakiran.hatenablog.com

ローカルでも正しく見れるようにするには、mkdocs.yml内に

use_directory_urls: false

を追加するだけです。

この記述を追加してmkdocs buildし、ローカルでhtmlを見ても正しく表示されてました。

また、siteフォルダを比較してみると、解決策を行う前はsiteフォルダにMarkdownファイルの名前のフォルダが生成されてましたが、 解決策を行った後はMarkdownファイルの名前のhtmlファイルに変わっていました。

具体的には

site
├ ...
├ page_1
│  └ index.html
└ index.html

site
├ ...
├ page_1.html
└ index.html

に変わりました。

なんにせよ、ローカルでも正しく見られるようになって良かった良かった。