ZirekHQ Documentation

Project board — live roadmap and status for this repo's issues.

Aggregated Antora documentation site for the ZirekHQ organization, structured after compress4j/compress4j.github.io.

Each source repo owns its own docs under docs/ (an Antora component: docs/antora.yml + docs/modules/ROOT/pages/*.adoc). This repo only holds the playbook, UI, and build tooling that stitches those components into one published site.

Currently a spike covering the components listed in antora-playbook.yaml. Add a repo by adding a content.sources entry in antora-playbook.yaml and a docs/antora.yml in that repo.

Versions

extensions/doc-versions.js overrides the version: in each component's docs/antora.yml:

• Every branch (main) publishes as Next, a prerelease. It is the default only while a component has no release.
• Only the newest vX.Y.Z tag of each major line publishes, as X.x. Below 1.0 each minor counts as a line (0.2.x).
• Other tags, such as betas (v4.0.2-beta.1), are skipped.
• home is unversioned.

Antora fails on a tag without docs/. When onboarding a repo, negate its older tags in antora-playbook.yaml (e.g. '!v1.5.*').

make install   # npm i
make build     # antora --fetch antora-playbook.yaml
make serve     # serve build/site locally

---

💝 Support This Project

If this repository saves you time and effort, please consider supporting it!

• ⭐ Star on GitHub
• 🐦 Share on Twitter
• 💖 Support on Open Collective

Landing page

npm run build also writes the landing page at /. scripts/build-home.js reads data/projects.json, fetches repository and release data from GitHub (set GH_TOKEN to avoid rate limits), and falls back to data/snapshot.json when GitHub is unreachable. Each build with live data rewrites the snapshot; commit it when it changes. The docs sit at the site root (/home/, /<component>/<version>/). scripts/redirects.js writes a small redirect page under /en/ for every docs page, so links from before the move keep working; delete it once they have settled.