docs-builder
docs-builder is Elastic's distributed documentation platform. It processes Markdown from multiple repositories into unified documentation sites, validates cross-repo references, and ships as native AOT binaries for CI.
docs-builder builds documentation across many repositories independently, then assembles them into unified experiences. There are three build modes:
- Assembler builds — Compose a global navigation over many repositories to produce a unified documentation site. Powers sites like elastic.co/docs.
- Codex builds — Create knowledge base environments where repositories publish independently at
/r/<repo>, optionally grouped under/g/<group>. - Isolated builds — Build a single repository's docs locally or as a PR preview.
Learn more about the distributed documentation model.
- OpenAPI — Generate interactive API reference documentation from OpenAPI specifications.
- CLI Schema — Generate CLI reference documentation from CLI Schema files.
- Release notes — Create, bundle, and publish release documentation from structured changelog files.
- Exporters — Export documentation as Elasticsearch documents, LLM Markdown, OKF, and plain text.
- MCP server — Let AI assistants and coding agents interact with Elastic documentation via the Model Context Protocol.
- REST API — Search, ask questions, and query documentation changes programmatically.
- docs-actions — Reusable GitHub Actions for documentation CI/CD.
- Elastic CLI — Search and read documentation from the
elasticCLI.
New to docs-builder? Start here:
- Getting started — Choose your path based on what you want to build.
- Installation — Install the docs-builder CLI.
- Syntax reference — Markdown syntax with MyST directives and roles.
- Configuration — Site-level, content-set, and page-level configuration.
- How-to guides — Guides for managing files, repositories, and releases.
- CLI reference — All docs-builder commands and options.
- Development guide — Building blocks, link infrastructure, navigation system, and contributing to docs-builder.