Skip to content

dev-centr/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dev Center 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

  • antora-playbook.online.yml:: The production Antora playbook. Uses remote GitHub URLs for all content sources and the published UI bundle. Used by CI/CD.

  • antora-playbook.yml:: The local dev playbook. Configured for local sibling directories and the devcntr-org organization structure.

  • antora-playbook.example.yml:: A committed template for the local dev playbook.

  • antora-playbook.testing.example.yml:: A committed template for full local testing.

🌍 Site URL

The documentation site is hosted at docs.devcntr.org. * docs.code-workspace:: VS Code workspace file configured for multi-root editing across documentation sources. * package.json:: Defines dependencies and build scripts.

Prerequisites

Usage

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.example.yml antora-playbook.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 build:online

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

Development

This project is best managed using the included VS Code workspace:

  1. Open docs.code-workspace in VS Code.

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

  3. Use the integrated terminal for running builds.

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors