antora-setup

Set up Antora documentation with Node.js, configuration files, and a ROOT module.

Updated Jul 9, 2026
One-click install
npx skills add https://github.com/albertoirurueta/ai-catalog --skill antora-setup
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: antora-setup
Source: https://github.com/albertoirurueta/ai-catalog/tree/main/.claude/skills/antora-setup
Command: npx skills add https://github.com/albertoirurueta/ai-catalog --skill antora-setup

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the setup of Antora documentation sites for repositories that lack one, streamlining the process of installing prerequisites, configuring antora.yml, and creating a basic documentation structure.

Core Features & Use Cases

  • Automated Prerequisite Installation: Handles Node.js and Antora toolchain installation.
  • Configuration: Writes antora.yml and antora-playbook.yml for the documentation.
  • Documentation Structure: Creates a minimal ROOT module with index, installation, and reference pages.
  • Use Case: For a repository without Antora documentation, running this Skill sets up the foundational documentation framework.

Quick Start

Use the /antora-setup slash command to bootstrap the Antora documentation for your repository.

Frequently Asked Questions about antora-setup

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up Antora documentation for a new repository?

Setting up Antora documentation requires installing Node.js, configuring the Antora toolchain, and writing essential files like `antora.yml` and `antora-playbook.yml` to establish a foundational documentation structure from scratch.

What files are needed to start Antora site generation?

Starting Antora site generation requires an `antora.yml` descriptor and an `antora-playbook.yml` file to define content aggregation, alongside a minimal `ROOT` module structure with index and reference pages.

Do I need to install Node.js before configuring Antora?

Yes, Node.js is a prerequisite for configuring Antora. The toolchain requires a Node.js environment to install the Antora CLI and necessary extensions before writing configuration files and generating the documentation site.

What is the best way to automate repository setup for Antora?

Automating Antora repository setup involves using scripts to handle Node.js prerequisite installation, write `antora.yml` and playbook configurations, and create a minimal `ROOT` module structure, ensuring a consistent foundational documentation framework.

Can I create a minimal documentation structure from scratch with Antora?

Yes, creating a minimal documentation structure with Antora involves setting up a `ROOT` module containing index, installation, and reference pages. This establishes the baseline content structure needed for the site generation process.

Why configure an antora-playbook file for document automation?

Configuring an `antora-playbook.yml` file is necessary for document automation because it defines content sources and UI bundles for aggregation. This enables the Antora toolchain to automatically generate the site without manual content intervention.