PureBuilder Simply
Welcome to PureBuilder Simply
PureBuilder Simply is a pre-built website building tool. It is also called a headless CMS or SSG.
PureBuilder Simply is easy to build and update, excels in writing functions, and is suitable for building text-centric websites.
Easy to start
Using PureBuilder Simply is very easy. Install what you need with RubyGems:
$ gem install pbsimply kramdown
Create a project folder wherever you like:
$ pbsimply-init mywebsite
All you have to do is write your article in Markdown!
Less restrictions
Many similar tools require complex file layouts and numerous dedicated files.
Not only are these systems cumbersome to build, but they also limit your freedom to build your site.
PureBuilder Simply, as the name suggests, is very simple. The
only rule you need is to put a configuration file
.pbsimply.yaml
in a folder of your choice.
Use engine you like
PureBuilder Simply uses Pandoc, a very powerful document processor, by default.
However, PureBuilder Simply is not a Pandoc-dependent tool. If you don’t want to use Pandoc, you can choose to use RDoc, RDoc/Markdown, RedCarpet, CommonMarker, kramdown, or any of the experimental DocUtils.
PureBuilder Simply also uses Ruby-style Marshal dumps as its
database by default, but you can use YAML or JSON-style databases
if you prefer. In addition, you can use the fast Oj
library if you use a JSON-format database.
SSR? SPA? As you wish!
The most standard use of PureBuilder Simply is to generate a document file completed by PureBuilder Simply and serve it as is via HTTP server.
However, this is not all PureBuilder Simply can do. You can also incorporate update processing on the server side and respond to it, or build only the main data to be used by the SPA.
The usage is flexible. A “JSON out” feature will be added in the near future to provide more powerful support for SPAs.
Also Unix or Windows
PureBuilder Simply was developed on Linux for use on Linux platforms.
However, it can also be run on Unix environments other than Linux (e.g., Mac OS X) and Windows.
On Windows, PureBuilder Simply can be run using the Windows Subsystem for Linux (WSL) or the Ruby binary for Windows.
Markdown and ReST
PureBuilder Simply uses Markdown as its source format.
This Markdown format depends on the engine you use. For example, if you use Pandoc, you can use the very powerful Pandoc Markdown.
In addition, the ReSTructured Text format is available for Pandoc and DocUtils, and the RDoc format is available for RDoc.
PureBuilder Simply gives you the freedom of choice at all times.
Powerful templates
If you use Pandoc, you can use the powerful Pandoc templates.
If you use something other than Pandoc, you can use the more powerful eRuby templates.
When using Pandoc, you can also use eRuby templates that have been processed using Pandoc templates.
Programmable platform
If you want to use PureBuilder Simply more powerfully, you can program PureBuilder Simply.
PureBuilder Simply provides various means of extending functionality. One example is Hooks.
With Hooks, you can add processing before or after the build.
Easier and more powerful is “Blessing.” PureBuilder Simply makes use of document metadata (YAML Frontmatter in Markdown), but Bless allows you to modify the metadata during document processing.