feat(v2): add onBrokenMarkdownLinks to API docs

facebook · Oct 31, 2020 · ce808b4 · ce808b4
1 parent 15f2b8f
commit ce808b4
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 1 deletion.
diff --git a/packages/docusaurus-migrate/src/__tests__/__fixtures__/expectedSiteConfig.js b/packages/docusaurus-migrate/src/__tests__/__fixtures__/expectedSiteConfig.js
@@ -31,6 +31,7 @@ module.exports = {
     facebookAppId: '199138890728411',
   },
   onBrokenLinks: 'log',
+  onBrokenMarkdownLinks: 'log',
   presets: [
     [
       '@docusaurus/preset-classic',

diff --git a/packages/docusaurus/src/server/configValidation.ts b/packages/docusaurus/src/server/configValidation.ts
@@ -68,7 +68,7 @@ const ConfigSchema = Joi.object({
     .default(DEFAULT_CONFIG.onBrokenLinks),
   onBrokenMarkdownLinks: Joi.string()
     .equal('ignore', 'log', 'warn', 'error', 'throw')
-    .default(DEFAULT_CONFIG.onBrokenLinks),
+    .default(DEFAULT_CONFIG.onBrokenMarkdownLinks),
   onDuplicateRoutes: Joi.string()
     .equal('ignore', 'log', 'warn', 'error', 'throw')
     .default(DEFAULT_CONFIG.onDuplicateRoutes),

diff --git a/website/docs/api/docusaurus.config.js.md b/website/docs/api/docusaurus.config.js.md
@@ -108,6 +108,14 @@ The broken links detection is only available for a production build (`docusaurus
 
 :::
 
+### `onBrokenMarkdownLinks`
+
+- Type: `'ignore' | 'log' | 'warn' | 'error' | 'throw'`
+
+The behavior of Docusaurus, when it detects any broken markdown link.
+
+By default, it prints a warning, to let you know about your broken markdown link, but you can change this security if needed.
+
 ### `onDuplicateRoutes`
 
 - Type: `'ignore' | 'log' | 'warn' | 'error' | 'throw'`

diff --git a/website/versioned_docs/version-2.0.0-alpha.66/api/docusaurus.config.js.md b/website/versioned_docs/version-2.0.0-alpha.66/api/docusaurus.config.js.md
@@ -108,6 +108,14 @@ The broken links detection is only available for a production build (`docusaurus
 
 :::
 
+### `onBrokenMarkdownLinks`
+
+- Type: `'ignore' | 'log' | 'warn' | 'error' | 'throw'`
+
+The behavior of Docusaurus, when it detects any broken markdown link.
+
+By default, it prints a warning, to let you know about your broken markdown link, but you can change this security if needed.
+
 ### `onDuplicateRoutes`
 
 - Type: `'ignore' | 'log' | 'warn' | 'error' | 'throw'`