diff --git a/deploy/ci.mdx b/deploy/ci.mdx index d5483fb3d..96a1a9059 100644 --- a/deploy/ci.mdx +++ b/deploy/ci.mdx @@ -36,6 +36,13 @@ broken link CI check automatically searches your documentation content for broke To see the results of this check, visit GitHub's check results page for a specific commit. +#### Configuration options + +The broken links check supports additional options: + +- **Check anchors**: Enable to validate anchor links like `/path/to/page#anchor`. When enabled, the check verifies that the target anchor exists on the destination page. +- **Check snippets**: Enable to validate [snippet](/components/reusable-snippets) references in your documentation. When enabled, the check verifies that all referenced snippet files exist. + ### Vale [Vale](https://vale.sh/) is an open source rule-based prose linter which supports a range of document types, including Markdown and MDX. Use Vale to check for consistency of style and tone in your documentation.