Antora Samples Template

Welcome to the Antora Samples Template. This documentation showcases all the AsciiDoc elements supported by Antora.

Getting Started

This template provides sample pages demonstrating every major AsciiDoc feature. Use it as a reference or starting point for your own documentation.

Features Overview

Feature Description

Typography

Headings, paragraphs, inline formatting, and links

Code Blocks

Syntax-highlighted source code examples

Admonitions

Note, tip, warning, caution, and important blocks

Tables

Various table layouts and styles

Blocks & Quotes

Sidebars, examples, quotes, and literal blocks

Lists

Ordered, unordered, and description lists

Images & Media

Image blocks and figure captions

Quick Example

Here’s a quick code example:

// Hello world in JavaScript
function greet(name) {
  console.log(`Hello, ${name}!`);
}

greet('World');
Explore each page to see the full range of AsciiDoc capabilities.

Installation

Clone this repository and build with Antora:

git clone https://github.com/the-dev-center/antora-demo-template.git
cd antora-demo-template
pnpm install
pnpm build

Then configure your antora-playbook.yml:

site:
  title: My Documentation
  start_page: component::index.adoc

content:
  sources:
    - url: .
      branches: HEAD
      start_path: docs

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