# @antora/playbook-builder

> Builds a playbook object from user input for configuring successive documentation components in an Antora pipeline.

Latest version **3.2.0** (published 2026-08-29) · MPL-2.0 license · 0 weekly downloads

## Install

```sh
npm install @antora/playbook-builder
pnpm add @antora/playbook-builder
yarn add @antora/playbook-builder
bun add @antora/playbook-builder
```

## Health

**Score 60/100 (C)** — status: active.

Positive: esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 3.2.0 |
| Published | 2026-08-29 |
| First published | 2018-01-12 |
| Weekly downloads | 0 |
| License | MPL-2.0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=20.0.0 |
| Dependencies | 4 |
| Unpacked size | 28.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | OpenDevise Inc. |
| Maintainers | mojavelinux, graphitefriction |
| Keywords | antora, antora-component, config, documentation, static site, web publishing |

## Links

- npm: https://www.npmjs.com/package/@antora/playbook-builder
- Repository: https://gitlab.com/antora/antora
- Homepage: https://antora.org
- Issues: https://gitlab.com/antora/antora/issues
- npm.io page: https://npm.io/package/@antora/playbook-builder

## Dependencies (4)

- [json5](https://npm.io/package/json5.md) ~2.2
- [convict](https://npm.io/package/convict.md) ~6.2
- [js-yaml](https://npm.io/package/js-yaml.md) ~5.4
- [@iarna/toml](https://npm.io/package/@iarna/toml.md) ~2.2

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 3.2.0 (latest) — 2026-08-29
- 3.2.0-rc.3 (testing) — 2026-08-12
- 3.2.0-rc.2 — 2026-06-20
- 3.2.0-rc.1 — 2026-06-19
- 3.1.15 — 2026-05-26
- 3.2.0-alpha.12 — 2026-05-12
- 3.2.0-alpha.11 — 2025-11-27
- 3.2.0-alpha.10 — 2025-10-03
- 3.1.14 — 2025-10-03
- 3.1.13 — 2025-09-30
- 3.2.0-alpha.9 — 2025-08-11
- 3.1.12 — 2025-08-06
- 3.1.11 — 2025-08-06
- 3.1.10 — 2024-12-05
- 3.2.0-alpha.8 — 2024-12-05
- … 86 more at https://npm.io/package/@antora/playbook-builder/versions

## README

# Antora Playbook Builder

The Playbook Builder is the configuration component for Antora.
It’s responsible for building a playbook object from user input that’s then used for configuring components in an Antora generator pipeline.

[Antora](https://antora.org) is a modular static site generator designed for creating documentation sites from AsciiDoc documents.
Its site generator aggregates documents from versioned content repositories and processes them using [Asciidoctor](https://asciidoctor.org).

## Copyright and License

Copyright (C) 2017-present [OpenDevise Inc.](https://opendevise.com) and the [Antora Project](https://antora.org).

Use of this software is granted under the terms of the [Mozilla Public License Version 2.0](https://www.mozilla.org/en-US/MPL/2.0/) (MPL-2.0).

---
_Source: https://npm.io/package/@antora/playbook-builder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._