Dev-Centr Documentation

This repository contains the Antora playbook and configuration for the Dev Center documentation site. It aggregates content from multiple sources to build a unified documentation portal.

Project Structure

File	Description
antora-playbook.yml	Production Antora playbook. Uses remote GitHub URLs for all content sources and the published UI bundle. Used by CI/CD.
antora-playbook-local.example.yml	Committed template for the local dev playbook. Copy to antora-playbook-local.yml (gitignored) for local builds.
antora-playbook.testing.example.yml	Committed template for full local testing (e.g. local UI bundle).
.vscode/	VS Code folder settings and extension recommendations for this playbook repo.
package.json	Defines dependencies and build scripts.

Usage

Prerequisites

Dependency	Notes
Node.js	LTS recommended
pnpm	Package manager for install and build scripts

Installation

Install the required dependencies using pnpm:

pnpm install

Getting Started (Local Development)

Copy the example playbook to create your local config:

cp antora-playbook-local.example.yml antora-playbook-local.yml

Then build the site locally:

pnpm build

Testing Local Plugins / UI

To also use a local UI bundle (e.g., when developing themes):

cp antora-playbook.testing.example.yml antora-playbook.testing.yml
# Edit antora-playbook.testing.yml to point to your local UI bundle
pnpm build:testing

Production / CI Build

To build with remote sources (as CI does):

pnpm run build:online

The output will be generated in the build/site directory (or as configured in the playbook).

Command	Purpose
pnpm install	Install dependencies
pnpm build	Build site with local playbook (antora-playbook-local.yml)
pnpm build:testing	Build with testing playbook (e.g. local UI bundle)
pnpm run build:online	Build with remote sources (production/CI)

Development

This project is best managed by opening the repository folder in VS Code:

1. Open this repository folder in VS Code (File → Open Folder).

2. Ensure the recommended extensions are installed (AsciiDoc, YAML, etc.).

3. Use the integrated terminal for running builds.