Antora Demo

A barebones Antora demo with sample pages demonstrating all AsciiDoc features.

Contents

• Overview
• Features Demonstrated
• Quick Start
  • Clone and Build
  • Serve Locally
• Project Structure
• Using This Template
  • As a Starting Point
  • For Theme Testing
• Requirements
• License
• Resources

Overview

This template provides a complete set of sample AsciiDoc pages covering every major documentation feature. Use it as:

• A reference for AsciiDoc syntax in Antora

• A starting point for new documentation projects

• A test suite for custom themes

Features Demonstrated

Page	Features
Typography	Headings, inline formatting, links, paragraphs, footnotes
Code Blocks	Syntax highlighting, callouts, line numbers, titles
Admonitions	NOTE, TIP, IMPORTANT, WARNING, CAUTION blocks
Tables	Headers, footers, alignment, nested content, CSV
Blocks & Quotes	Sidebars, examples, quotes, verses, collapsible blocks
Lists	Ordered, unordered, description, checklists, nested
Images & Media	Block images, alignment, captions, icons

Quick Start

Clone and Build

git clone https://github.com/antora-supplemental/antora-demo.git
cd antora-demo
pnpm install
pnpm build

Serve Locally

pnpm serve

This builds the site and opens it in your browser at http://localhost:8080.

Project Structure

antora-demo/
├── docs/
│   ├── antora.yml              # Component descriptor
│   └── modules/ROOT/
│       ├── nav.adoc            # Navigation
│       └── pages/              # Sample pages
│           ├── index.adoc
│           ├── typography.adoc
│           ├── code-blocks.adoc
│           ├── admonitions.adoc
│           ├── tables.adoc
│           ├── blocks.adoc
│           ├── lists.adoc
│           └── images.adoc
├── antora-playbook.yml         # Antora playbook
├── package.json
└── README.adoc

Using This Template

As a Starting Point

1. Fork or clone this repository

2. Modify docs/antora.yml with your component name

3. Update antora-playbook.yml with your site title

4. Replace sample content with your own documentation

For Theme Testing

1. Clone this repository

2. Add your theme’s supplemental UI:

   ui:
     bundle:
       url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable
       snapshot: true
     supplemental_files: ./path/to/your/supplemental-ui

3. Build and verify all elements are styled correctly

Requirements

• Node.js 18+

• pnpm (recommended) or npm

License

This project is licensed under the MIT License.

Resources

• Antora Documentation

• AsciiDoc Language Documentation