elastic/docs-builder

최근 기록된 소스 활동: 2026년 10월 21일 08:46

SkillsMP 카탈로그 업데이트: 2026년 10월 29일 18:30

수집된 skills: 8

GitHub 스타: 25
GitHub 포크: 45

AI 어시스턴트로 설치

이 프롬프트를 복사해 사용 중인 AI 어시스턴트에 입력하세요.

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

저장소 README

README 원본 파일: README.md

README 원본 보기

README 전체 펼치기

# 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 [.NET 10.0](https://dotnet.microsoft.com/en-us/download/dotnet/10.0), 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.

저장소 README를 불러오는 중…

이 저장소의 skills

소프트웨어 개발자 소프트웨어 품질 보증 분석가·테스터

직업 카테고리 2개 · 63% 분류됨

skill

직업 분류

설명

업데이트

test

미분류

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.

원문 언어: 영어

2026-10-21

commit

미분류

Stage relevant files and create a well-formed git commit for the docs-builder repo. Use this when the user asks to commit changes, save work, or create a commit.

원문 언어: 영어

2026-10-14

pr

미분류

Create a GitHub pull request for the current branch with a focused why/what body and exactly one release-drafter label. Use when the user asks to open a PR, create a pull request, or ship a branch.

원문 언어: 영어

2026-10-14

issue

소프트웨어 품질 보증 분석가·테스터

File a well-formed bug report or feature request. Use when the user asks to open an issue, report a bug, or request a feature in the docs-builder repo.

원문 언어: 영어

2026-09-02

feature-flag

소프트웨어 개발자

Registers a feature flag as additive-only and verifies the flag-off path still matches the previous default. Use whenever adding or extending a feature flag, editing FeatureFlags.cs, changing feature_flags in assembler.yml, gating a code path behind a…

원문 언어: 영어

2026-09-02

lint

소프트웨어 개발자

Auto-fix all formatting issues in the docs-builder repo — runs dotnet format for C# and npm fmt:write for TypeScript/JS. Use when the user asks to fix formatting, lint the code, or when a pre-commit hook fails due to formatting.

원문 언어: 영어

2026-04-28

style-review

소프트웨어 품질 보증 분석가·테스터

Review changed or staged C# code against the docs-builder coding standards and flag violations. Use when the user asks to review code style, check for standards violations, or audit a diff before committing.

원문 언어: 영어

2026-04-28

mcp-search

소프트웨어 개발자

Search, analyze, and author Elastic documentation using the remote MCP server. Use this when the user asks about Elastic product documentation, features, or APIs; wants to find, read, or verify existing docs pages; is writing or editing documentation;…

원문 언어: 영어

2026-02-19

수집된 skill 8개 중 8개를 표시합니다.