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.

Install docs-builder Elastic documentation

Get started in 4 steps

Install docs-builder, write your first page, then preview and publish it.

  1. Install docs-builder

    Build from source

    Clone the repository and build the CLI yourself.

    dotnet build
    Run in a container

    No local install needed.

    Container setup

  1. Write your first page

    Author Markdown, add links, and use the directive set.

    Start writing

  2. Preview and publish

    Serve the site locally with live reload, then publish it.

    Serve locally

  3. 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.

Go to latest release notes:
Ready to move to the latest version? Upgrade docs-builder

Get hands-on

New to the toolchain? Follow a guided path from install to published page.

Documentation this toolchain builds

The published Elastic documentation, linked with cross-repository links.

Explore docs-builder

Find what you need, organized by task, from authoring and building to publishing and operating.

Authoring

Builds and configuration

Structured data and operations