mdhelpはHTML Help(.chm)のヘルプを生成することを目的としたHUGOのテーマです。テーマ本体に加え、HTML Help生成に利用するツールなどを含んでいます。HTML Helpの生成には別途HTML Help Workshopが必要です。
詳しい使い方はmdhelp Docsを参照してください。
- HUGOをダウンロード・インストールし、
hugo.exe
にPATHを通しておきます。 - Microsoft HTML Help Downloadsから
Htmlhelp.exe
をダウンロード・インストールし、hhc.exe
にPATHを通しておきます。
git clone https://github.com/mochimochiki/mdhelp.git
cd mdhelp
以下のバッチを実行すると2種類のconfigでHUGOのビルド及びヘルプの生成が行われます。
.\exampleSite\CI\build.bat
以下が成果物です。
.\exampleSite\public_chm\jp\mdhelp.chm
.\exampleSite\public_chm\en\mdhelp.chm
原稿のmdファイル名は英数字とパーセントエンコーディングされない記号のみ対応しています。日本語など、URLがパーセントエンコーディングされるファイル名の場合、chmコンパイル時にエラーが発生します。