Setup

birbrain uses Antora to generate my AsciiDoc contents.

Starting from scratch

Follow this guide.

Make sure to commit the git repository otherwise the site won’t be generated. This error will occur:

(@antora/content-classifier): Start page specified for site not found: 知識::index.adoc

Automated Site Building on Github Pages

The structure of this notebook is to have a repository for Antora and multiple different repositories for the components.

The process is straightforward: push to the repository of components. This action triggers a workflow, which in turn initiates another workflow that will deploy the Antora document to Github Pages.

Diagram

See Github Actions.

Changes

I currently use the default antora ui because I have no idea how to create my own user interface from scratch. I think it is recommended to bundle your own UI instead of modifying it by parts.

supplementary_ui/partials changes:

  • edit-this-page.hbs

  • footer-content.hbs

  • header-content.hbs

Extensions

Wants

This would require a UI rewrite from scratch meaning I have to learn frontend development?!?!?

  • Backlinks

  • Note previews