Skip to content

Commit fbabe4b

Browse files
authored
Merge pull request #4443 from ClickHouse/allow-configuring-on-broken-anchors
Allow configuring onBrokenAnchors for Docusaurus, add a README note
2 parents e2e44c7 + 4740f20 commit fbabe4b

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,10 @@ You can run a copy of this website locally within a few steps. Some folks find t
8080
# [INFO] Use `npm run serve` command to test your build locally.
8181
# ✨ Done in 105.96s.
8282
```
83+
84+
> [!TIP]
85+
> If the build command is failing due to broken anchors,
86+
> it is possible to ignore these temporarily by running `ON_BROKEN_ANCHORS=ignore yarn build` instead.
8387

8488
1. Start the local web-server:
8589

docusaurus.config.en.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ const config = {
5757
onBrokenLinks: "throw",
5858
onBrokenMarkdownLinks: "warn",
5959
onDuplicateRoutes: "throw",
60-
onBrokenAnchors: "throw",
60+
onBrokenAnchors: process.env.ON_BROKEN_ANCHORS ?? "throw",
6161
favicon: "img/docs_favicon.ico",
6262
organizationName: "ClickHouse",
6363
trailingSlash: false,

0 commit comments

Comments
 (0)