Configuration file

Configuration File Structure

The configuration file is named .pbsimply.yaml and can be placed in any directory. The file format is YAML.

The directory containing .pbsimply.yaml is treated as the “document source root.”

Values in config.

Key Type Description
outdir String Base directory for output. Required
template String Path to Pandoc HTML template file. If not set, template is temaplte.html
css String / Array Path to CSS file(s)
toc Boolean Turn on TOC if true
unicode_normalize String If given, Unicode normalize source document before processing. It muse be either nfc, nfd, nkfc or nfkd
pandoc_additional_options Array Extra pandoc options
post_eruby Boolean Process Pandoc output with eRuby if true
alt_frontmatter Hash Default frontmatter in ACCS index
default_meta Hash Default frontmatter
testserver_port Fixnum Port number of pbsimply-testserver (default 8000)
self_url_prefix String Absolute path prefix for URL of generated document itself instead of /.
self_url_external_prefix String Like self_url_prefix, but it only works on page_url_encoded_external.
dbstyle String If json given, Indexes database is used .indexes.json instead of .indexes.rbm. Also oj is same as it, but use Oj library instead of JSON standard library.
bless_style String If cmd given, blessing with command instead of Ruby procs.
bless_cmd String / Array Command for blessing.
bless_accscmd String / Array Command for ACCS blessing.
blessmethod_accs_rel String Automatic blessing method for find next/prev article.
accs_order String If desc is set, ACCS article list is sorted by descending order (on default template.)
accs_across_category Boolean Don’t separate ACCS article lists by category (on default template.)
accs_sort_by String Sorting method for ACCS article list. default (date, title, last update), title (title, date), name (filename, title, date) and serial (serial, date, filename) are avilable. It works on default template.
auto_delete Boolean Delete output file when source file is deleted or turned to draft.
detect_modification String Detecting modification method. changes looks change changes header. mtimesize looks mtime and file size. Otherwise, it looks mtime.
pandoc_command String Pandoc command. pandoc is default.
jsonout Boolean If true, output JSON instead of HTML.
jsonout_include String[] Array of keys to include frontmatter with jsonout. This settings is preffered over jsonout_exclude.
jsonout_exclude String[] Array of keys to exclude from frontmatter with jsonout.