Skip to content

Allow configuring onBrokenAnchors for Docusaurus, add a README note #4443

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 17, 2025
Merged

Allow configuring onBrokenAnchors for Docusaurus, add a README note #4443

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,10 @@ You can run a copy of this website locally within a few steps. Some folks find t
# [INFO] Use `npm run serve` command to test your build locally.
# ✨ Done in 105.96s.
```

> [!TIP]
> If the build command is failing due to broken anchors,
> it is possible to ignore these temporarily by running `ON_BROKEN_ANCHORS=ignore yarn build` instead.

1. Start the local web-server:

Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.en.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ const config = {
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
onDuplicateRoutes: "throw",
onBrokenAnchors: "throw",
onBrokenAnchors: process.env.ON_BROKEN_ANCHORS ?? "throw",
favicon: "img/docs_favicon.ico",
organizationName: "ClickHouse",
trailingSlash: false,
Expand Down