Tackler Documentation Playbook

This is Antora playbook project for Tackler documentation.

Documentation Toolchain

The Tackler documentation is generated with Antora toolchain.

Running Antora

You can either install Antora locally, or use the container image.

Lunr search extension

In both cases, you have to first install an Antora extension for Lunr search engine:

Lunr with antora local installation

npm i @antora/lunr-extension

Lunr with Antora container image

podman run -v $PWD:$PWD:Z -w $PWD  --rm -t antora/antora npm i @antora/lunr-extension

The container image is preferred way - it’s super simple, just run:

podman run -v $PWD:$PWD:Z -w $PWD  --rm -t antora/antora antora-playbook.yml

This will use published versions for documentation sources and UI toolkit from Github repositories.

Use following command to build the documentation from locally edited sources.

Before that you have to have documentation source code available as workspace/tackler, and UI-bundle as workspace/ui-bundle.zip. See UI section below for details.

The actual source for tackler documentation is available at tackler-ng/tackler-docs.

podman run -v $PWD:$PWD:Z -w $PWD  --rm -t antora/antora local-antora-playbook.yml

UI

You don’t have build UI by default. Only reason to build UI is if you have to modify it.

You can download ui-bundle from URL listed in the antora-playbook.yml or you can build it locally.

The UI code is located here:

git clone https://github.com/tackler-ng/antora-ui-tackler

UI Bundle

If you don’t have node environment installed, easiest way to generate UI is build it in side container:

podman run --publish 127.0.0.1:5252:5252 -v $PWD:$PWD:Z -w $PWD  --rm -it node:22-alpine ash

Then inside the container:

npm install
npx gulp preview
npx gulp bundle

License

Tackler documentation is licensed under the Apache License, version 2.0.