docs: fix errors building on docusaurus v3

1. Versioned sidebars can no longer be prefixed with their versions 2. Fix an HTML tag not closing before the end of the line (??) 3. Fix syntax of the <Interpolate> component 4. The header now needs to point to an existing page, and redirects will just work (??) Some docs: https://docusaurus.io/docs/migration/v3
express-validator · Feb 11, 2024 · b6aec35 · b6aec35
1 parent 5112bde
commit b6aec35
Show file tree

Hide file tree

Showing 22 changed files with 268 additions and 270 deletions.
diff --git a/docs/api/validation-result.md b/docs/api/validation-result.md
@@ -121,8 +121,7 @@ formatWith<T>(formatter: ErrorFormatter<T>): Result<T>
 Rewraps the validation state in a new `Result` object that uses `formatter` as its [error formatter](#errorformatter).
 
 <details>
-<summary>💭 Why does this method return a new Result?
-</summary>
+<summary>💭 Why does this method return a new Result?</summary>
 
 If you've read through other pages of this documentation, you might be asking yourself why can't
 `.formatWith()` mutate itself, like validation chains do?

diff --git a/docs/guides/getting-started.md b/docs/guides/getting-started.md
@@ -203,7 +203,7 @@ This is a better scenario, but it can still be improved. Let's continue.
 While the user can no longer send empty person names, it can still inject HTML into your page!
 This is known as the [Cross-Site Scripting vulnerability (XSS)](https://en.wikipedia.org/wiki/Cross-site_scripting).
 
-Let's see how it works. Go to [<Interpolate values={{ query: '<b>John</b>' }}>http://localhost:3000/hello?person={query}</Interpolate>](http://localhost:3000/hello?person=%3Cb%3EJohn%3C/b%3E),
+Let's see how it works. Go to [<Interpolate values={{ query: '<b>John</b>' }}>{'http://localhost:3000/hello?person={query}'}</Interpolate>](http://localhost:3000/hello?person=%3Cb%3EJohn%3C/b%3E),
 and you should see "Hello, <b>John</b>!".
 
 While this example is fine, an attacker could change the `person` query string to a `<script>` tag

diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -75,7 +75,7 @@ const themeConfig = {
  },
  {
  label: 'API Reference',
- to: 'docs/check-api',
+ to: 'docs/api/check',
  },
  ],
  },

diff --git a/website/versioned_docs/version-7.0.0/api/validation-result.md b/website/versioned_docs/version-7.0.0/api/validation-result.md
@@ -121,8 +121,7 @@ formatWith<T>(formatter: ErrorFormatter<T>): Result<T>
 Rewraps the validation state in a new `Result` object that uses `formatter` as its [error formatter](#errorformatter).
 
 <details>
-<summary>💭 Why does this method return a new Result?
-</summary>
+<summary>💭 Why does this method return a new Result?</summary>
 
 If you've read through other pages of this documentation, you might be asking yourself why can't
 `.formatWith()` mutate itself, like validation chains do?

diff --git a/website/versioned_docs/version-7.0.0/guides/getting-started.md b/website/versioned_docs/version-7.0.0/guides/getting-started.md
@@ -203,7 +203,7 @@ This is a better scenario, but it can still be improved. Let's continue.
 While the user can no longer send empty person names, it can still inject HTML into your page!
 This is known as the [Cross-Site Scripting vulnerability (XSS)](https://en.wikipedia.org/wiki/Cross-site_scripting).
 
-Let's see how it works. Go to [<Interpolate values={{ query: '<b>John</b>' }}>http://localhost:3000/hello?person={query}</Interpolate>](http://localhost:3000/hello?person=%3Cb%3EJohn%3C/b%3E),
+Let's see how it works. Go to [<Interpolate values={{ query: '<b>John</b>' }}>{'http://localhost:3000/hello?person={query}'}</Interpolate>](http://localhost:3000/hello?person=%3Cb%3EJohn%3C/b%3E),
 and you should see "Hello, <b>John</b>!".
 
 While this example is fine, an attacker could change the `person` query string to a `<script>` tag

diff --git a/website/versioned_sidebars/version-5.2.0-sidebars.json b/website/versioned_sidebars/version-5.2.0-sidebars.json
@@ -1,23 +1,23 @@
 {
- "version-5.2.0/docs": {
+ "docs": {
  "Introduction": [
- "version-5.2.0/index"
+ "index"
  ],
  "Features": [
- "version-5.2.0/sanitization",
- "version-5.2.0/custom-validators-sanitizers",
- "version-5.2.0/custom-error-messages",
- "version-5.2.0/wildcards",
- "version-5.2.0/schema-validation",
- "version-5.2.0/whole-body-validation"
+ "sanitization",
+ "custom-validators-sanitizers",
+ "custom-error-messages",
+ "wildcards",
+ "schema-validation",
+ "whole-body-validation"
  ]
  },
  "api": [
- "version-5.2.0/check-api",
- "version-5.2.0/filter-api",
- "version-5.2.0/sanitization-chain-api",
- "version-5.2.0/validation-chain-api",
- "version-5.2.0/validation-result-api",
- "version-5.2.0/legacy-api"
+ "check-api",
+ "filter-api",
+ "sanitization-chain-api",
+ "validation-chain-api",
+ "validation-result-api",
+ "legacy-api"
  ]
 }
diff --git a/website/versioned_sidebars/version-5.3.0-sidebars.json b/website/versioned_sidebars/version-5.3.0-sidebars.json
@@ -1,23 +1,23 @@
 {
- "version-5.3.0/docs": {
+ "docs": {
  "Introduction": [
- "version-5.3.0/index"
+ "index"
  ],
  "Features": [
- "version-5.3.0/sanitization",
- "version-5.3.0/custom-validators-sanitizers",
- "version-5.3.0/custom-error-messages",
- "version-5.3.0/wildcards",
- "version-5.3.0/schema-validation",
- "version-5.3.0/whole-body-validation"
+ "sanitization",
+ "custom-validators-sanitizers",
+ "custom-error-messages",
+ "wildcards",
+ "schema-validation",
+ "whole-body-validation"
  ]
  },
  "api": [
- "version-5.3.0/check-api",
- "version-5.3.0/filter-api",
- "version-5.3.0/sanitization-chain-api",
- "version-5.3.0/validation-chain-api",
- "version-5.3.0/validation-result-api",
- "version-5.3.0/legacy-api"
+ "check-api",
+ "filter-api",
+ "sanitization-chain-api",
+ "validation-chain-api",
+ "validation-result-api",
+ "legacy-api"
  ]
 }
diff --git a/website/versioned_sidebars/version-6.0.0-sidebars.json b/website/versioned_sidebars/version-6.0.0-sidebars.json
@@ -1,24 +1,24 @@
 {
- "version-6.0.0/docs": {
+ "docs": {
  "Introduction": [
- "version-6.0.0/index"
+ "index"
  ],
  "Features": [
- "version-6.0.0/sanitization",
- "version-6.0.0/custom-validators-sanitizers",
- "version-6.0.0/custom-error-messages",
- "version-6.0.0/wildcards",
- "version-6.0.0/schema-validation",
- "version-6.0.0/whole-body-validation",
- "version-6.0.0/running-imperatively"
+ "sanitization",
+ "custom-validators-sanitizers",
+ "custom-error-messages",
+ "wildcards",
+ "schema-validation",
+ "whole-body-validation",
+ "running-imperatively"
  ]
  },
  "api": [
- "version-6.0.0/check-api",
- "version-6.0.0/validation-chain-api",
- "version-6.0.0/filter-api",
- "version-6.0.0/sanitization-chain-api",
- "version-6.0.0/matched-data-api",
- "version-6.0.0/validation-result-api"
+ "check-api",
+ "validation-chain-api",
+ "filter-api",
+ "sanitization-chain-api",
+ "matched-data-api",
+ "validation-result-api"
  ]
 }
diff --git a/website/versioned_sidebars/version-6.1.0-sidebars.json b/website/versioned_sidebars/version-6.1.0-sidebars.json
@@ -1,24 +1,24 @@
 {
- "version-6.1.0/docs": {
+ "docs": {
  "Introduction": [
- "version-6.1.0/index"
+ "index"
  ],
  "Features": [
- "version-6.1.0/sanitization",
- "version-6.1.0/custom-validators-sanitizers",
- "version-6.1.0/custom-error-messages",
- "version-6.1.0/wildcards",
- "version-6.1.0/schema-validation",
- "version-6.1.0/whole-body-validation",
- "version-6.1.0/running-imperatively"
+ "sanitization",
+ "custom-validators-sanitizers",
+ "custom-error-messages",
+ "wildcards",
+ "schema-validation",
+ "whole-body-validation",
+ "running-imperatively"
  ]
  },
  "api": [
- "version-6.1.0/check-api",
- "version-6.1.0/validation-chain-api",
- "version-6.1.0/filter-api",
- "version-6.1.0/sanitization-chain-api",
- "version-6.1.0/matched-data-api",
- "version-6.1.0/validation-result-api"
+ "check-api",
+ "validation-chain-api",
+ "filter-api",
+ "sanitization-chain-api",
+ "matched-data-api",
+ "validation-result-api"
  ]
 }
diff --git a/website/versioned_sidebars/version-6.10.0-sidebars.json b/website/versioned_sidebars/version-6.10.0-sidebars.json
@@ -1,28 +1,28 @@
 {
- "version-6.10.0/docs": {
+ "docs": {
  "Introduction": [
- "version-6.10.0/index"
+ "index"
  ],
  "Features": [
- "version-6.10.0/sanitization",
- "version-6.10.0/custom-validators-sanitizers",
- "version-6.10.0/custom-error-messages",
- "version-6.10.0/wildcards",
- "version-6.10.0/schema-validation",
- "version-6.10.0/whole-body-validation",
- "version-6.10.0/running-imperatively"
+ "sanitization",
+ "custom-validators-sanitizers",
+ "custom-error-messages",
+ "wildcards",
+ "schema-validation",
+ "whole-body-validation",
+ "running-imperatively"
  ],
  "More": [
- "version-6.10.0/faq",
- "version-6.10.0/migration-v5-to-v6"
+ "faq",
+ "migration-v5-to-v6"
  ]
  },
  "api": [
- "version-6.10.0/check-api",
- "version-6.10.0/validation-chain-api",
- "version-6.10.0/filter-api",
- "version-6.10.0/sanitization-chain-api",
- "version-6.10.0/matched-data-api",
- "version-6.10.0/validation-result-api"
+ "check-api",
+ "validation-chain-api",
+ "filter-api",
+ "sanitization-chain-api",
+ "matched-data-api",
+ "validation-result-api"
  ]
 }
diff --git a/website/versioned_sidebars/version-6.11.0-sidebars.json b/website/versioned_sidebars/version-6.11.0-sidebars.json
@@ -1,28 +1,28 @@
 {
- "version-6.11.0/docs": {
+ "docs": {
  "Introduction": [
- "version-6.11.0/index"
+ "index"
  ],
  "Features": [
- "version-6.11.0/sanitization",
- "version-6.11.0/custom-validators-sanitizers",
- "version-6.11.0/custom-error-messages",
- "version-6.11.0/wildcards",
- "version-6.11.0/schema-validation",
- "version-6.11.0/whole-body-validation",
- "version-6.11.0/running-imperatively"
+ "sanitization",
+ "custom-validators-sanitizers",
+ "custom-error-messages",
+ "wildcards",
+ "schema-validation",
+ "whole-body-validation",
+ "running-imperatively"
  ],
  "More": [
- "version-6.11.0/faq",
- "version-6.11.0/migration-v5-to-v6"
+ "faq",
+ "migration-v5-to-v6"
  ]
  },
  "api": [
- "version-6.11.0/check-api",
- "version-6.11.0/validation-chain-api",
- "version-6.11.0/filter-api",
- "version-6.11.0/sanitization-chain-api",
- "version-6.11.0/matched-data-api",
- "version-6.11.0/validation-result-api"
+ "check-api",
+ "validation-chain-api",
+ "filter-api",
+ "sanitization-chain-api",
+ "matched-data-api",
+ "validation-result-api"
  ]
 }
diff --git a/website/versioned_sidebars/version-6.12.0-sidebars.json b/website/versioned_sidebars/version-6.12.0-sidebars.json
@@ -1,28 +1,28 @@
 {
- "version-6.12.0/docs": {
+ "docs": {
  "Introduction": [
- "version-6.12.0/index"
+ "index"
  ],
  "Features": [
- "version-6.12.0/sanitization",
- "version-6.12.0/custom-validators-sanitizers",
- "version-6.12.0/custom-error-messages",
- "version-6.12.0/wildcards",
- "version-6.12.0/schema-validation",
- "version-6.12.0/whole-body-validation",
- "version-6.12.0/running-imperatively"
+ "sanitization",
+ "custom-validators-sanitizers",
+ "custom-error-messages",
+ "wildcards",
+ "schema-validation",
+ "whole-body-validation",
+ "running-imperatively"
  ],
  "More": [
- "version-6.12.0/faq",
- "version-6.12.0/migration-v5-to-v6"
+ "faq",
+ "migration-v5-to-v6"
  ]
  },
  "api": [
- "version-6.12.0/check-api",
- "version-6.12.0/validation-chain-api",
- "version-6.12.0/filter-api",
- "version-6.12.0/sanitization-chain-api",
- "version-6.12.0/matched-data-api",
- "version-6.12.0/validation-result-api"
+ "check-api",
+ "validation-chain-api",
+ "filter-api",
+ "sanitization-chain-api",
+ "matched-data-api",
+ "validation-result-api"
  ]
 }
diff --git a/website/versioned_sidebars/version-6.13.0-sidebars.json b/website/versioned_sidebars/version-6.13.0-sidebars.json
@@ -1,28 +1,28 @@
 {
- "version-6.13.0/docs": {
+ "docs": {
  "Introduction": [
- "version-6.13.0/index"
+ "index"
  ],
  "Features": [
- "version-6.13.0/sanitization",
- "version-6.13.0/custom-validators-sanitizers",
- "version-6.13.0/custom-error-messages",
- "version-6.13.0/wildcards",
- "version-6.13.0/schema-validation",
- "version-6.13.0/whole-body-validation",
- "version-6.13.0/running-imperatively"
+ "sanitization",
+ "custom-validators-sanitizers",
+ "custom-error-messages",
+ "wildcards",
+ "schema-validation",
+ "whole-body-validation",
+ "running-imperatively"
  ],
  "More": [
- "version-6.13.0/faq",
- "version-6.13.0/migration-v5-to-v6"
+ "faq",
+ "migration-v5-to-v6"
  ]
  },
  "api": [
- "version-6.13.0/check-api",
- "version-6.13.0/validation-chain-api",
- "version-6.13.0/filter-api",
- "version-6.13.0/sanitization-chain-api",
- "version-6.13.0/matched-data-api",
- "version-6.13.0/validation-result-api"
+ "check-api",
+ "validation-chain-api",
+ "filter-api",
+ "sanitization-chain-api",
+ "matched-data-api",
+ "validation-result-api"
  ]
 }