設定ファイル

設定ファイルの構成

設定ファイルは.pbsimply.yamlというファイル名で、任意のディレクトリに置くことができます。 ファイル形式はYAMLです。

.pbsimply.yamlがあるディレクトリが「ドキュメントソースルート」として扱われます。

設定ファイルの値

Key Type Description
outdir String 出力先ベースディレクトリ。必須
template String Pandoc HTMLテンプレートファイル。 temaplte.htmlがデフォルト
css String / Array CSSファイル
toc Boolian 真ならばTOCを生成する
unicode_normalize String 設定されている場合、ソースドキュメント処理前にノーマライズを行う。nfc, nfd, nkfc, nfkdのいずれかを指定する
pandoc_additional_options Array 追加で渡されるPandocのコマンドラインオプション
post_eruby Boolean 真にするとPandocの出力をerbによってプロセッシングする
alt_frontmatter Hash ACCSインデックスファイルのデフォルトのfrontmatter
default_meta Hash デフォルトのfrontmatter
testserver_port Fixnum pbsimply-testserverが使用するポート(default 8000)
self_url_prefix String 生成されたドキュメントのURLの絶対パスのプレフィックス部。デフォルトは/
self_url_external_prefix String self_url_prefixのpage_url_encoded_external用
dbstyle String indexesデータベースに使うファイル形式を指定する。marshal, yaml, json, ojが指定できる。obを指定した場合、JSON形式でOjライブラリを使用する
bless_style String cmdの場合、Ruby Procを使用する通常のblessではなくコマンドを使用する
bless_cmd String / Array blessに使用するコマンド
bless_accscmd String / Array ACCSのblessに使用するコマンド
blessmethod_accs_rel String 「次」「前」の記事を探索する自動blessメソッド
auto_delete Boolean ソースドキュメントが消えた場合、出力ドキュメントからも削除する
detect_modification String 更新の検出方法。changesはchangesヘッダーの変更から検出する。mtimesizeはmtimeとファイルサイズから検出する。 これ以外の場合、mtimeで検出する
pandoc_command String Pandocのコマンド。デフォルトはpandoc
pandoc_input_ext Hash Pandocで処理させるソースドキュメントの形式。
jsonout Boolean 真である場合、JSON形式で出力する
jsonout_include String[] jsonoutで出力されるJSONに含むfrontmatterのキーの配列。この設定はjsonout_excludeより優先される
jsonout_exclude String[] jsonoutで出力されるJSONから除外されるfrontmatterのキーの配列