Skip to content

Commit 644c8f6

Browse files
authored
Throw an exception on broken MD links (#12)
The default is to print a warning when a Markdown link is unresolved, meaning that docs builds can succeed with links that cause 404s.
1 parent e9e7438 commit 644c8f6

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docusaurus.config.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ import { extendedPostcssConfigPlugin } from "./server/postcss";
2525
const latestVersion = getLatestVersion();
2626

2727
const config: Config = {
28+
onBrokenMarkdownLinks: "throw",
2829
customFields: {
2930
innkeepConfig: {
3031
apiKey: process.env.INKEEP_API_KEY,
@@ -145,7 +146,7 @@ const config: Config = {
145146
[
146147
"@docusaurus/plugin-content-docs",
147148
{
148-
// Host docs on the root page, later it will be exposed on goteleport.com/docs
149+
// Host docs on the root page, later it will be exposed on goteleport.com/docs
149150
// next to the website and blog
150151
// https://docusaurus.io/docs/docs-introduction#docs-only-mode
151152
routeBasePath: "/",

0 commit comments

Comments
 (0)