A bare-bones static site generator in the form of a single Bash script.
Currently, mrbones is only supported on Linux systems. It has the following dependencies:
- GNU sed
- realpath (from GNU coreutils)
- find (from GNU findutils)
- GNU Make (optionally, if you wish to use the Makefile)
- pre-commit (optionally, if you wish to run local tests or develop)
You can use the Makefile to install/uninstall mrbones:
$ sudo make install # you can also use DESTDIR to specify *where* to install
$ sudo make uninstall # use same DESTDIR as for `make install`You can invoke mrbones like so:
$ mrbones [option(s)] [root_site_dir]If not specified, [root_site_dir] defaults to . (the current directory). You can see the options
by running mrbones --help.
By default, mrbones will copy everything in the root_site_dir to a new directory called
_site/, which will contain the generated static site. However, HTML templates can be used to make
development easier. These can be put under _templates/ in root_site_dir. This directory is
special to mrbones and will not be copied verbatim; instead, templates can be put in there, that
may be used by other pages. These enable the following directives:
@include <FILE>. The include directive copies a template file verbatim into the file that contains it. For example, consider two pages:_templates/main.htmlcontaining"hello!";index.htmlcontaining"@include main.html\ngoodbye!". The generated_site/index.htmlpage will contain"hello!\ngoodbye!", as_templates/main.htmlwas included inindex.html. Note that there should be at most one include directive per line, and the line should not contain anything else.
@use <FILE>. The use directive fills in a template with the content of another page. For example, consider two pages:_templates/main.htmlcontaining"<html>@content</html>";index.htmlcontaining"@use main.html\nhello!". The generated_site/index.htmlpage will contain"<html>hello!</html>", asindex.htmlwas used to fill the_template/main.htmltemplate. Note that there should be at most one use directive per line, and the line should not contain anything else. In addition, the template used in the use directive must contain at least one@contentdirective, to indicate where the page's content should be placed. Multiple@contentdirectives will lead to the page's content being placed in multiple parts of the template.
See CONTRIBUTING.md.
mrbones by Dimitri Kokkonis is licensed under a
Creative Commons Attribution-ShareAlike 4.0 International License.