はじめましょう
インストールする
PureBuilder SimplyはRubyGemsを用いてインストールすることができます。
$ gem install pbsimply
プロジェクトをつくる
PureBuilder
Simplyのプロジェクトは、.pbsimply.yaml
ファイルが置かれた任意のフォルダです。
まずはフォルダを作りましょう。 ここで行う方法では、「ウェブサイトプロジェクトのルートフォルダ」になります。
フォルダを作ったら、pbsimply-init
コマンドでプロジェクトを作りましょう。
引数として、ルートフォルダのファイルパスを指定します。
$ pbsimply-init path/to/root
これにより、Source
とBuild
のフォルダがルートフォルダ以下に作られ、Sourceにはいくつかのファイルが配置されます。
Source
が「ドキュメントソースルート」、Build
が「ドキュメントビルドルート」です。
この方法で開始したプロジェクトはドキュメントプロセッサにkramdownを使うようになっています。 kramdownをインストールしましょう。
$ gem install kramdown
これで準備は完了です。
記事を書く
ドキュメントソースルートのarticles
フォルダには、20231028-untitled.md
というファイルがあります。
まずはこのファイルを編集するところから始めましょう。
ファイル名はPureBuilder Simplyにとって重要なことではありませんが、記事を管理する上では重要です。 ファイル名の規則を導入すると良いでしょう。
title
が記事の題名で、date
はYYYY-MM-DD
形式の記事の日付です。
日付は手動でつけます。手順を考えると、手動で入れたほうが合理的だからです。
title
とdate
は原則として記入する必要がありますが、date
がない場合はビルド時の日付が自動的に入ります。
category
はACCSの機能で利用するためのものです。
記事の一覧をカテゴリ分けして表示するのに利用できます。
ドキュメントはMarkdown形式で書かれています。 Markdownについては別のページに説明があります。
Markdownのページの説明はやや細かいものなので、まずはサンプルのファイルを参考にして真似て書くのが良いでしょう。
ビルドする
それではビルドしましょう。Source
フォルダ上でコマンドを実行します。
$ pbsimply articles
これでBuild
フォルダにarticles
フォルダができていて、その中にビルドした記事が出来上がっているでしょう。
articles
フォルダは「ACCSディレクトリ」というものになっていて、index.html
も出来上がっています。
公開する
Build
の中身をディレクトリをウェブサーバーの公開ルートに置けば、ウェブサイトとして公開されます。
このとき、いくつか注意点があります。
まず、Build
の中の構成は変更してはいけません。
場合にもよりますが、PureBuilder
Simplyの機能によって提供されるパスと食い違いが発生してしまいます。
ですから、articles
の中身を公開ルートに置いてはいけません。
また、articles
の中身にアクセスするために、公開ルート上のファイル(例えばidnex.html
)から、articles
へのリンクが必要になるでしょう。
PureBuilder
Simplyは基本的にパス上のルートに配置されることを想定しています。
例えば、https://www.exmaple.com/
です。
もし公開ルートがサブパスに存在する、例えばhttps://www.example.com/foo/
のような場合は、.pbsimply.yaml
を編集して設定する必要があります。self_url_prefix
です。
self_url_prefix: /foowebsite/
画像などを置く
画像などはBuild
上にコピーし、それをサーバー上にアップロードするようにしましょう。
詳しく知る
Pandocを使った本格的な構成を行うには、Pandocを使うを読んでください。
PureBuilder Simplyを本格的に利用するには、詳しく知るを読んでください。