ヘルプの構成

ヘルプを構成するためのconfig.tomlの主な項目の説明をします。HUGO公式ドキュメントも合わせて参照してください。

Config

publishDir

出力ディレクトリです。public_(environment名)と設定します。例えばchmディレクトリに配置したconfig.tomlではpublic_chmと設定します。

ignoreFiles

無視するファイル。エディションごとで出力ディレクトリやファイルを変更する場合に使用します。例えばignoreFiles = ["ignore"]とするとignoreの含まれるディレクトリ・ファイルがビルド対象外（ヘルプの目次作成からも対象外）になります。

Config.params

[params]以下に設定する設定値です。

author

フッターに表示されるauthorを設定します。

copyRightYear

フッターに表示されるCopyRightの年を設定します。

isCHM

CHMかどうか。この設定は通常Webサイト用のconfig.tomlではfalseとし、HTML Help生成用のconfig.tomlではtrueにします。テンプレートでWebサイトとヘルプ生成時で処理を分ける際に使用します。

custom_css

独自のcssを利用する場合に設定します。例えば/static/css/custom.cssにcssファイルを配置しcustom_css = ["/css/custom.css"]とするとcustom.cssが適用されます。

custom_js

独自のjavascriptを利用する場合に設定します。例えば/static/js/custom.jsにjsファイルを配置した場合、custom_js = ["/js/custom.js"]とするとjavascriptが適用されます。

showIfs

ShowIf/HideIfフロントマター/ショートコードで表示する条件の一覧。

showIfs = ["editionA", "editionB"]

例えば上記のように設定した場合、.mdファイルで以下のブロックは表示されます。

{{% ShowIf editionA %}}
ここにeditionAの場合に表示するコンテンツを記述。
{{% /ShowIf %}}

以下のブロックは表示されません。

{{% HideIf editionA %}}
ここはeditionAのみ非表示とする。
{{% /HideIf %}}

記事単位では以下のようにフロントマターを書いている場合、その記事はchmに含まれます。一つのエディションだけであってもリスト形式（["editionA"]）で書く必要があります。

---
title: editionAの説明
ShowIf: ["editionA"]
---

---
title: editionA以外はこの説明
HideIf: ["editionA"]

本設定について詳しくはエディションを参照してください。

Config.languages

[languages] - [languages.jp] などに設定する設定値です。

title

各言語のヘルプタイトルです。ヘルプのファイル名称およびウィンドウタイトルに利用されます。

フロントマター

記事のフロントマターでの設定は以下のとおりです。

hideHelpTOC

ヘルプの目次のチャプター（ツリーの本アイコン部分）として表示するかどうか。デフォルトでは表示されます。隠す場合はチャプターの_index.mdのフロントマターに以下のようにhideHelpTOCを追加します。

hideHelpTOC: true

© 2020 - 2021 mochimo.GitHub