Get Started

Installing

PureBuilder Simply can be installed using RubyGems.

$ gem install pbsimply

Create project

The PureBuilder Simply project is an arbitrary folder with a .pbsimply.yaml file.

First, create a folder. In the method we will do here, this will be the “root folder of the website project”.

After creating the folder, create a project with the command pbsimply-init. As an argument, specify the file path of the root folder.

$ pbsimply-init path/to/root

This will create Source and Build folders under the root folder, with some files placed in Source. Source is the “document source root” and Build is the “document build root”.

Projects started this way use kramdown for the document processor. Install kramdown.

$ gem install kramdown

Okay, now ready.

Write article

In the articles folder in the document source root, you will find a file named 20231028-untitled.md. Start by editing this file.

File names are not important for PureBuilder Simply, but they are important for managing articles. It is a good idea to introduce a filename convention.

Where title is the title of the article and date is the date of the article in YYYYY-MM-DD format. The date is added manually. This is because it is more reasonable to put the date manually considering the procedure. As a rule, title and date must be filled in, but if date is missing, the date at the time of build is automatically entered.

category is for use with ACCS functions. It can be used to categorize and display a list of articles.

The document is written in Markdown format. Markdown is explained on another page.

The instructions on the Markdown page are somewhat detailed, so it is a good idea to start by referring to the sample files and writing them in an imitation manner.

Build

Now let’s build. Run the command on the Source folder.

$ pbsimply articles

You will now have an articles folder in your Build folder with the built articles in it.

The articles folder is now an “ACCS directory” and the index.html is also ready.

Publish

Place the contents of Build in a directory in the public root of your web server and it will be published as a web site.

There are a few things to keep in mind at this point.

First, the configuration inside the Build must not be changed. Depending on the case, there will be discrepancies with the path provided by the PureBuilder Simply functionality.

Therefore, you should not put the contents of articles in the public root. You will also need a link to the articles from a file on the public root (e.g. idnex.html) in order to access the contents of the articles.

PureBuilder Simply is basically intended to be placed in the root on a path. For example, https://www.exmaple.com/. If the public root resides on a subpath, for example https://www.example.com/foo/, you will need to edit .pbsimply.yaml to set it. self_url_prefix.

self_url_prefix: /foowebsite/

Put images

Images, etc. should be copied on the Build and then uploaded to the server.

Learn More

To do a full-scale configuration using Pandoc, please read Using Pandoc..

To make full-scale use of PureBuilder Simply, please read Specification.