Docs system template

Tools and config files to quickly build a docs/notes system with asciidoctor and automatically publish on GitHub pages using GitHub actions.

On the development side, it features

• Live reloading

• Docker environment to get it going in 5 minutes.

To me, the greatest pleasure (and where most of the time is spent) in this project is setting up live reloading mechanism and the Docker environment. It’s a lot of fun piecing things together.

Run with Docker

docker compose up

then open the generated build/index.html in the browser.

Run without Docker

Warning

It only works for MacOS with Homebrew and Ruby installed :P

1. Run make setup to set up dependencies.

2. Run make.

3. Open the generated build/index.html in the browser.