docs: make site build throw on broken links (#5009)

typescript-eslint · May 17, 2022 · 186fcf7 · 186fcf7
1 parent 1d8220a
commit 186fcf7
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/packages/eslint-plugin/docs/rules/README.md b/packages/eslint-plugin/docs/rules/README.md
@@ -39,7 +39,7 @@ See [Configs](/docs/linting/configs) for how to enable recommended rules using c
 | [`@typescript-eslint/no-base-to-string`](./no-base-to-string.md)                                             | Requires that `.toString()` is only called on objects which provide useful information when stringified                 | :lock:                   |          | :thought_balloon: |
 | [`@typescript-eslint/no-confusing-non-null-assertion`](./no-confusing-non-null-assertion.md)                 | Disallow non-null assertion in locations that may be confusing                                                          | :lock:                   | :wrench: |                   |
 | [`@typescript-eslint/no-confusing-void-expression`](./no-confusing-void-expression.md)                       | Requires expressions of type void to appear in statement position                                                       |                          | :wrench: | :thought_balloon: |
-| [`@typescript-eslint/no-duplicate-enum-values`](./docs/rules/no-duplicate-enum-values.md)                    | Disallow duplicate enum member values                                                                                   | :lock:                   |          |                   |
+| [`@typescript-eslint/no-duplicate-enum-values`](./no-duplicate-enum-values.md)                               | Disallow duplicate enum member values                                                                                   | :lock:                   |          |                   |
 | [`@typescript-eslint/no-dynamic-delete`](./no-dynamic-delete.md)                                             | Disallow the delete operator with computed key expressions                                                              | :lock:                   | :wrench: |                   |
 | [`@typescript-eslint/no-empty-interface`](./no-empty-interface.md)                                           | Disallow the declaration of empty interfaces                                                                            | :white_check_mark:       | :wrench: |                   |
 | [`@typescript-eslint/no-explicit-any`](./no-explicit-any.md)                                                 | Disallow usage of the `any` type                                                                                        | :white_check_mark:       | :wrench: |                   |

diff --git a/packages/website/docusaurus.config.js b/packages/website/docusaurus.config.js
@@ -15,8 +15,8 @@ const config = {
   tagline: 'Tooling which enables ESLint to support TypeScript',
   url: 'https://typescript-eslint.io',
   baseUrl: '/',
-  onBrokenLinks: 'warn', // TODO: 'throw'
-  onBrokenMarkdownLinks: 'warn',
+  onBrokenLinks: 'throw',
+  onBrokenMarkdownLinks: 'warn', // If Markdown link resolution fails, it will result in a broken link anyways
   favicon: 'img/favicon.ico',
   organizationName: 'typescript-eslint',
   projectName: 'typescript-eslint',