Stackable Documentation

This is the main repository for the documentation of the Stackable platform. It uses Antora.

This repository hosts the Antora playbook file as well as some generic documentation modules.

To build the site install Antora and run:

antora antora-playbook.yml

Warning

Due to a bug this will not currently work in Node 16. I recommend using the latest LTS release (14) until the issue is resolved.

Development

During development, it can be helpful to change the playbook so that the source does point at the local directory instead of the remote git repository:

content:
  sources:
  - url: ./
    branches: HEAD

Note	Antora does not recognize git submodules as git repositories

The design & layout comes from our UI repository.

hikhvar/documentation

Stackable Documentation

Development