Pandocを使う

Pandocを使ったPureBuilder Simply

PureBuilder SimplyはデフォルトでPandocを使うようになっており、Pandocを使うことで非常に強力なMarkdownフォーマットとテンプレートエンジンを使うことができます。

高度な機能を使えますが、Pandocをインストールすることが場合によっては難しい要素になりえます。 このため、pbsimply-initはRubyのライブラリ(kramdown)を使うようにしています。

Pandocを使った構成にするためには、別の手順が必要です。

Pandocのインストール

Linuxの環境では、パッケージとして用意されているものではパッケージをインストールするだけで大丈夫です。 例えばArch linuxでは次のようにします。

$ sudo pacman -S pandoc

OpenSUSEでも同じようにパッケージをインストールするだけで利用できます。 OpenSUSE LeapはWindows Storeでイメージとして提供されているため、WindowsでWSLを使う場合でも有用です。

$ sudo zypper in pandoc

Pandocはデフォルトでpandocというコマンドで呼ばれます。 .pbsimply.yamlのpandoc_commandを設定することで上書きすることもできます。

Windowsで利用したい場合、WSL上のLinuxイメージにPandocをインストールすることもできますが、パフォーマンスの面で言えばWindowsのネイティブなPandocを用いる方が優れています。 WSLからも、RubyのWindowsバイナリが用いるMSYS2環境からもWindows上の実行ファイルを実行することができます。

Windows上にPandocをインストールしたあとは、2つの方法があります。

ひとつは、Windowsバイナリを環境からpandocというコマンドとして認識されるようにすることです。 例えば/usr/local/bin/pandocとして次のように書きます。

#!/bin/bash
exec "/mnt/c/Program Files/Pandoc/pandoc.exe"

もうひとつは.pbsimply.yamlで設定するという方法です。

pandoc_command: "/mnt/c/Program Files/Pandoc/pandoc.exe"

プロジェクトディレクトリをつくる

pbsimply-initコマンドの-tオプションでPandocのテーマを選択します。 例えばPaperテーマを使うには次のようにします。

pbsimply-init -t pandoc/paper foo

これでfooディレクトリ以下にSourceとBuildが作られます。 foo/Source/.pbsimply.yamlはPandocを使用する設定になっています。

利用可能なテーマはpbsimply-init -lで確認することができます。 pandoc/で始まるテーマを選択しましょう。

テンプレート

template.htmlはPandocのテンプレートファイルです。 仕様についてはPandoc User’s Guide#Templatesを参照してください。

template.htmlを編集する必要があるテーマには、template.htmlも含まれています。

最初からテンプレートを設定したい場合、

pandoc -D html5

とすることでデフォルトのテンプレートを出力できます。

さらに詳しく

基本的な使い方は、はじめましょうにあるものと同じです。

より深く理解し、使いこなしたい場合は詳しく知るを読んでください。