roll

Rolled my own static website builder 💻

NameSizeMode
..
README.md 1K -rw-r--r--
01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# roll

Rolled my own static website builder 💻

roll aims to provide a minimalist user interface and implement the following
simple feature set:

* fast incremental builds: only render pages and blog posts if necessary
* accessible and optimized HTML output implementing best practices
* moves `<script>` and `<style>` tags in Markdown content to the document's 
  `<head>`

## usage

See `example/` for an example of how to set up your blog's tree. You can render
the HTML pages of a blog located in the directory `INPUT_DIR` by running the
following command:

```console
$ roll INPUT_DIR
```

roll will output the HTML pages in the directory `INPUT_DIR/site/`. By default,
roll only renders pages and blog posts if they were last modified after the
corresponding HTML pages in `INPUT_DIR/site/`. To overwrite this use the `-B`
flag.

## configuration & customization

roll provides a number of configuration keys at compile-time. See
`config.toml`.

roll does not support customization of the HTML output: it is entirely tailored
to my personal blog, and _no templating system is provided_. If you want to use
this for your own blog, you should clone it and modify the source code.

## installation

roll can be installed using the following commands:

```console
$ git clone git://git.pablopie.xyz/roll
$ cargo install --path ./roll
```

## build dependencies

* [KaTeX](https://katex.org/) for rendering LaTeX equations
* [syntect](https://github.com/trishume/syntect) for syntax-highlighting