From 1d1ccc744939d7602f851fbb4496752bcfafe335 Mon Sep 17 00:00:00 2001 From: Paul Gottschling Date: Thu, 31 Oct 2024 09:47:36 -0400 Subject: [PATCH] Throw an exception on broken MD links The default is to print a warning when a Markdown link is unresolved, meaning that docs builds can succeed with links that cause 404s. --- docusaurus.config.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docusaurus.config.ts b/docusaurus.config.ts index acb891a..f81c18a 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -25,6 +25,7 @@ import { extendedPostcssConfigPlugin } from "./server/postcss"; const latestVersion = getLatestVersion(); const config: Config = { + onBrokenMarkdownLinks: "throw", customFields: { innkeepConfig: { apiKey: process.env.INKEEP_API_KEY, @@ -145,7 +146,7 @@ const config: Config = { [ "@docusaurus/plugin-content-docs", { - // Host docs on the root page, later it will be exposed on goteleport.com/docs + // Host docs on the root page, later it will be exposed on goteleport.com/docs // next to the website and blog // https://docusaurus.io/docs/docs-introduction#docs-only-mode routeBasePath: "/",