Antora Documentation Site

This directory contains the Antora playbook and site assembly logic for the Trento documentation hub. It builds the docs hub from the documentation maintained in this repository together with documentation fetched from upstream component repositories.

The Antora content assembly is controlled by two main files:

Examples of fetched component repositories include:

For the full current list of fetched repositories, refer to trento-docs-site/antora.yml.

Use the root README.adoc when you want the default repository-wide preview workflow with docker compose. Use the commands in this page when you are working directly in trento-docs-site/ and want a focused Antora-site build without the full compose environment.

How to Build and Preview the Site

1. Clone the Repository

git clone git@github.com:trento-project/docs.git;
cd docs/trento-docs-site

2. Install Dependencies

npm install

This installs the Antora dependencies and extensions declared in trento-docs-site/package.json.

3. Build Antora page

npx antora antora-playbook.yml

The build fetches documentation from the upstream repositories defined in antora.yml, so network access is required.

This generates the site into ./build/trento-docs-site-public.

This build consumes trento-docs-site-ui/build/ui-bundle.zip. If you changed the UI sources in trento-docs-site-ui/, rebuild the UI bundle first or your docs hub preview will still use the previous bundle.

4. Preview Locally

To preview the generated site in your browser, start a local static web server:

npx http-server build/trento-docs-site-public/ -c-1 -p 3000

  • -c-1: Disables caching

  • -p 3000: Runs the server on port 3000

Open your browser and visit: localhost at port 3000