Skip to content

Commit

Permalink
Throw an exception on broken MD links (#12)
Browse files Browse the repository at this point in the history
The default is to print a warning when a Markdown link is unresolved,
meaning that docs builds can succeed with links that cause 404s.
  • Loading branch information
ptgott authored Oct 31, 2024
1 parent e9e7438 commit 644c8f6
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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: "/",
Expand Down

0 comments on commit 644c8f6

Please sign in to comment.