docs-builder documentation hub
The toolchain that builds Elastic's documentation. Author in Markdown, validate cross-repository links, preview locally, and publish one unified site.
Get started in 4 steps
Install docs-builder, write your first page, then preview and publish it.
-
Install docs-builder
-
Write your first page
Author Markdown, add links, and use the directive set.
-
Preview and publish
Serve the site locally with live reload, then publish it.
-
Validate the build
Check links, syntax, and frontmatter before you open a pull request.
What's new in docs-builder
Recent additions to the toolchain and the syntax it understands.
-
Hub pages
A product-scoped landing page composed entirely from directives.
Read more -
Explore sections
Collapse a long link list into a stack of accordions.
Read more -
Get started sections
One opinionated onboarding path, with a copyable install command.
Read more -
Link cards
A card with a title, a description, and a validated link list.
Read more -
Card groups
Group related cards under a heading, or as one accordion.
Read more
Get hands-on
New to the toolchain? Follow a guided path from install to published page.
-
Author a page, add links, and preview it locally.
-
Run the local preview server, then publish the built site.
-
Every directive and role the toolchain understands.
Documentation this toolchain builds
The published Elastic documentation, linked with cross-repository links.
-
Elasticsearch
Search and analytics documentation.
-
Observability
Logs, metrics, traces, and alerting documentation.
-
Security
SIEM, endpoint, and detection documentation.
Explore docs-builder
Find what you need, organized by task, from authoring and building to publishing and operating.
Authoring
-
Syntax
-
Card directives
-
Getting started
-
Formatting
-
Page metadata
Builds and configuration
-
Build types
-
Catalog
-
Catalog reference
Structured data and operations
-
Exporters
-
Operations