elastic/docs-builder

Última atividade de origem registrada: 21 de outubro de 2026 às 08:46

Catálogo do SkillsMP atualizado: 5 de novembro de 2026 às 19:57

skills coletadas: 8

Estrelas no GitHub: 25
Forks no GitHub: 45

Instalar com um assistente de IA

Copie este prompt para o assistente de IA que você usa.

Follow https://skillsmp.com/skill-install/prompt.md to install Agent Skills from https://github.com/elastic/docs-builder.

README do repositório

Arquivo de origem do README: README.md

Ler o README original

Expandir README completo

# docs-builder [![ci](https://github.com/elastic/docs-builder/actions/workflows/ci.yml/badge.svg?branch=main&event=push)](https://github.com/elastic/docs-builder/actions/workflows/ci.yml) Distributed documentation tooling for a distributed company. * *`docs-builder`* command line tool to generate single doc-sets Distributed [as native macOS, Linux, and Windows binaries for several CPU architectures.](#installation) The documentation files: * are written in common Markdown with [Additional syntax extensions](https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/syntax/) to produce a richer writing and reading experience. * By conventions the documentation lives in `docs` folder but the tooling will look for any folder holding the `docset.yml` configuration file given the current working directory. > [!TIP] > To learn how to use docs-builder to contribute docs to Elastic, refer to [Contribute to the docs locally](https://www.elastic.co/docs/contribute-docs/locally ). ## Distributed documentation The main driver for folks writing documentation is `docs-builder`. This tool builds each repository in isolation and in addition produces a full mapping of all the linkable resources it contains in a `links.json` file. Each time a repository successfully builds on its respective main integration branch, our automation will publish its links.json file. For example, [Elasticsearch's links.json](https://elastic-docs-link-index.s3.us-east-2.amazonaws.com/elastic/elasticsearch/main/links.json) representing all linkable resources in the Elasticsearch repository. The `docs-builder assemble` command then assembles all the repositories in the [link-registry](https://elastic-docs-link-index.s3.us-east-2.amazonaws.com/link-index.json) using their last known good commit. This allows us to: * Validate outbound and inbound links ahead of time, even during local `docs-builder` builds. * Snapshot builds: only building commits that produced a `links.json` * Documentation errors in one repository won't affect all the others. * Resilient to repositories having build failures on their integration branches, we fall back to the last known good commit. ## Installation ### Linux / OSX ```bash curl -sL https://ela.st/docs-builder-install | sh ``` ### Windows ```ps iex (New-Object System.Net.WebClient).DownloadString('https://ela.st/docs-builder-install-win') ``` Installing through the script will download the latest version of the tool and make it available in your `PATH`. If you want to manually install the tool you can download the latest release from the [Releases Page](https://github.com/elastic/docs-builder/releases) ### Building locally Install [mise](https://mise.jdx.dev/getting-started.html), run `mise trust` once in the root git folder (every worktree of the clone is then trusted), and run `mise install` (or install the [.NET SDK](https://dotnet.microsoft.com/en-us/download/dotnet/10.0) version in `global.json` yourself), then run: ```bash ./build.sh publishbinaries ``` After which the locally built binaries will be available at: * **docs-builder**: `./.artifacts/publish/docs-builder/release/docs-builder` ## Getting started Our [Documentation](https://www.elastic.co/docs/contribute-docs/locally) is the best place to learn how to start using the tool locally. The essential commands are: * Running `docs-builder` from the root of any checkout with a `docs` folder will build the documentation. * Running `docs-builder` consecutively will only rebuild the documentation that has changed. * Running `docs-builder` with the `--force` flag will force a full rebuild of the documentation. * You can target different folders by passing a path to `docs-builder --path <path>` * Running `docs-builder serve` will provide a local server with live reloading. * You can leave this command running while you add/remove/rename files in your `docs` folder. ### Other commands to know: * `docs-builder mv` [Move files and folders](https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/contribute/move) * `docs-builder diff validate` [Manage redirects across doc sets](https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/contribute/redirects#validation) * `docs-builder inbound-links validate-link-reference` can be used after a build to validate the local `links.json` against all published documentation. For a complete reference of all available commands, refer to the [CLI documentation](https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/cli). ## Github Action The `docs-builder` tool is available as a GitHub action. It runs as native code on a distroless image `~25mb` so there is little overhead invoking the tooling. ```yaml jobs: docs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - name: Build documentation uses: elastic/docs-builder@main ``` ### GitHub Pages To set up the tool to publish to GitHub Pages, use the following configuration. ```yaml name: Build the docs on: push: branches: - main workflow_dispatch: permissions: contents: read pages: write id-token: write jobs: docs: runs-on: ubuntu-latest environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} steps: - name: Check out the repo uses: actions/checkout@v4 - name: Publish Github uses: elastic/docs-builder/actions/publish@main id: deployment with: continue-on-error: "true" private: true ``` This single action will build and validate the documentation before publishing. Make sure your repository settings are set up to deploy from GitHub actions see: https://github.com/elastic/{your-repository}/settings/pages --- ![actions/publish/github-pages.png](actions/publish/github-pages.png) --- # Local development Refer to [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to develop locally and contribute to the project.

Carregando o README do repositório…

Skills neste repositório

Desenvolvedores de software Analistas de garantia de qualidade de software e testadores

2 categorias ocupacionais · 63% classificado

skill

ocupação

descrição

atualizado

test

sem classificação

Run the relevant tests for what changed — detects whether to run C# unit tests, specific test projects, integration tests, or JS/TS tests based on changed files. Use when the user asks to run tests, verify changes, or check if something is broken.