ドキュメントプロセッサ

ドキュメントプロセッサの選択

PureBuilder SimplyはデフォルトでドキュメントプロセッサにPandocを使います。 Pandocは非常に強力なツールであり、PureBuilder Simplyを最大限に活用することができます。

ただし、PureBuilder SimplyはPandocに依存はしておらず、他のドキュメントプロセッサを選択することもできます。使用するプロセッサは.pbsimply.yamlのpbsimply_processorの値を用いて指定します。

プロセッサ	pbsimply_processor
RDoc	`rdoc`
RDoc/Markdown	`rdoc_markdown`
Kramdown	`kramdown`
Redcarpet	`redcarpet`
CommonMarker (cmark-gfm)	`cmark`
Docutils (実験的)	`docutils`

ただし、Pandocが最も強力であり、Pandoc以外のドキュメントプロセッサを選択すると機能的な制約を受ける場合があります。

pbsimply-initを用いて初期化する際、バージョン3.xにおいてはテーマを指定しないとKrandownのテーマが使用されます。これはPandocの導入がユーザーにとってある程度重い作業であること、PureBuilder Simplyを実行できるRuby環境がある前提であればKrandownの導入は容易であることからです。

ドキュメントプロセッサの解説

RDoc

説明

Rubyの標準ドキュメントシステムのRDocを用います。ソースファイルはRDocであるとして処理し、対象は*.rdocファイルに限られます。

テンプレートはeRubyテンプレートを使用します。

Dependency

rdoc library

使用できない設定

css
toc
pandoc_additional_options
post_eruby

RDoc/Markdown

説明

Rubyの標準ドキュメントシステムのRDocのMarkdownプロセッサを用います。ソースファイルはMarkdownであるとして処理し、対象は*.mdファイルに限られます。

テンプレートはeRubyテンプレートを使用します。

Dependency

rdoc library

使用できない設定

css
toc
pandoc_additional_options
post_eruby

Kramdown

説明

RubyのMarkdownライブラリ、Kramdownを用いて生成します。ソースファイルはMarkdownであるとして処理し、対象は*.mdファイルに限られます。

テンプレートはeRubyテンプレートを使用します。

Dependency

kramdown library

使用できない設定

css
toc
pandoc_additional_options
post_eruby

追加される設定

Key	Type	Description
`kramdown_features`	Hash	`Kramdown::Document.new`の第2引数として渡される連想配列。詳細はAPIドキュメントを参照すること。

Redcarpet

説明

RubyのMarkdownライブラリ、Redcarpetを用いて生成します。ソースファイルはMarkdownであるとして処理し、対象は*.mdファイルに限られます。

テンプレートはeRubyテンプレートを使用します。

Dependency

redcarpet library

使用できない設定

css
toc
pandoc_additional_options
post_eruby

追加される設定

Key	Type	Description
`redcarpet_extensions`	Hash	Redcarpetの拡張を示す連想配列。詳細はRedcarpetのページを参照

CommonMarker

説明

libcmark-gfmのRubyラッパーであるCommonMarkerを用いて生成します。ソースファイルはMarkdownであるとして処理し、対象は*.mdファイルに限られます。

table及びstrikethrough拡張を有効にした状態で処理されます。

テンプレートはeRubyテンプレートを使用します。

Dependency

libcmark-gfm
commonmarker library

使用できない設定

css
toc
pandoc_additional_options
post_eruby

追加される設定

Key	Type	Description
`commonmarker_options`	Array	`render_doc`に渡される拡張の配列

Docutils

説明

Pythonで書かれたReSTructured Textプロセッサ、Docutilsを用いて生成します。ソースファイルはReSTructured Textであるとして処理し、対象は*.rstファイルに限られます。

Dependency

Docutils (rst2html5)

使用できない設定

toc
pandoc_additional_options

追加される設定

Key	Type	Description
`docutils_options`	Array	`rst2html5`コマンドに渡されるコマンドラインオプション引数