Skip to content

Repository files navigation

Site

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.yml

Local sibling-repo playbook (committed). Expects ../devcentr, ../templates, ../general-knowledge, and ../msi-generator beside this repo.

antora-playbook.testing.yml

Same local content sources, but points ui.bundle at ../valentus-theme/build/ui-bundle.zip for theme work.

supplemental-ui/

Site overlay on the valentus-theme 2.x UI bundle: custom domain CNAME, accent-token brand CSS, header logo under img/, and a thin head-meta.hbs fork that loads the brand stylesheet. Header logo / navbar text use playbook site.keys.

.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)

Clone the content repos as siblings of this playbook repo (see antora-playbook-local.yml), then:

pnpm build

Testing Local Plugins / UI

Build the local UI bundle in a sibling valentus-theme checkout, then:

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.

About

Dev-Centr documentation hub. Antora site aggregating dev-centr projects.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages