コマンドライン
pbsimply
基本的な使い方
pbsimply [-fIA] [-m FILE] <directory>
pbsimply [-fIA] [-o FILE] [-m FILE] <document>ソースドキュメントからHTMLドキュメントを生成します。
コマンドラインオプション
| オプション | 内容 |
|---|---|
-f, --force-refresh |
すべてのドキュメントを強制的に更新する。テンプレートを更新した場合に便利 |
-I, --skip-index |
.indexes.${ext}に登録しない |
-A, --skip-accs |
ACCSの処理をしない |
-o FILE, --output |
出力ファイルをFILEに指定する |
-m FILE,
--additional-metafile |
さらに追加のメタデータYAMLファイル |
実際の使い方
pbsimplyコマンドはフォルダを対象にすることも、ファイルを対象にすることもできます。
ただし、ファイル指定はより高度な運用のためのものなので、通常はフォルダを指定することになります。
-fオプションをつけない場合、pbsimplyは内容が更新されたファイルのみを処理します(差分ビルド)。
テンプレートの更新は差分として検出されないため、テンプレートを更新した場合は-fオプションが必要になります。
フォルダを指定した場合、フォルダがACCSフォルダであるならばACCSの処理も行われます。
pbsimplyはドキュメントソースルート上で実行されることを期待しています。
一応、サブフォルダ内で実行することも可能です。
しかし、サブフォルダ内で実行する場合でも、指定するフォルダ/ファイルのパスはドキュメントソースルートから見た相対になるため、混乱を避ける意味でもドキュメントソースルート上で実行することを推奨します。
pbsimply-init
基本的な使い方
pbsimply-init [-t THEME] [-fs] [<directory>]
pbsimply-init [-l]PureBuilder Simplyのドキュメントソースルートおよびドキュメントビルドルートを生成します。 ディレクトリを指定した場合そのディレクトリをドキュメントソースルートとドキュメントビルドルートを配置するディレクトリとし、指定しない場合カレントディレクトリに配置します。
コマンドラインオプション
| オプション | 内容 |
|---|---|
-l, --list-themes |
テーマを一覧して終了する |
-f, --force |
生成するディレクトリがすでに存在する場合でも上書きして生成する |
-s, --source-only |
ドキュメントソースルートのみを生成する |
-t THEME, --theme |
指定したテーマでドキュメントソースルートを構築する |
-sオプションを指定した場合、指定されたディレクトリはドキュメントルートディレクトリを配置するディレクトリではなく、ソースドキュメントルートそのものであるとみなされます。
実際の使い方
最初に始めるときは空のフォルダを用意してそこに移動し
pbsimply-initとするのが基本です。
-tオプションを指定しないとデフォルトのテーマが使用されます。
例えばpandoc/bloggyテーマを使用したい場合は
pbsimply-init -t pandoc/bloggyのように指定します。
別のテーマを上書きインストールしたい場合は
pbsimply-init -sf -t pandoc/warm Sourceのように-sオプションと-fオプションをつけ、ソースドキュメントルートを指定することで上書きできます。
ただし、テーマに存在するすべてのファイルで上書きされるため設定ファイルも上書きされることに注意してください。
pbsimply-initは既に設定ファイル(.pbsimply.yaml)が存在する場合、.pbsimply.yaml.origとしてバックアップを行います。必要に応じてマージしてください。
pbsimply-testserver
基本的な使い方
pbsimply-testserverドキュメントソースルート上でのみ実行でき、.pbsimply.yamlを読み取ってドキュメントビルドルートをHTTPで配信します。
依存関係
pbsimply-testserverはwebrick
Gemを必要とします。
実際の使い方
ウェブで公開するビルドされたドキュメントはリンクをHTTP
URLにする必要があるため、多くの場合ローカルファイルとして開いても検証ができません。
そのため、HTTPアクセスで確認できるようにするためのスクリプトがpbsimply-testserverです。
他の任意のウェブサーバーでも検証することはできますが、pbsimply-testserverはドキュメントソースルートからドキュメントビルドルートの配信を行うことができるため、VSCodeのような組み込み端末を持つエディタを使用している場合に利便性があります。
ポートは.pbsimply.yamlのtestserver_portで指定します。
また、バインドするアドレスはtestserver_addressで指定することができます。127.0.0.2のようなアドレスを指定することで衝突を避けてバインドすることができます。
サブディレクトリ
pbsimply-testserverは基本的にドメインのルートディレクトリ(例:
http://exmaple.com/index.html)で配信されることを想定しています。
サブ階層での配信が必要な環境(例:
http://example.com/site/index.html)に向けてビルドしている場合、ドキュメントソースディレクトリ上でsiteフォルダを作り、その中にサイトの中身を作っていくのがおすすめです。