docs: bump docusaurus to v3. (kysely-org#1050)

thecodrr · Sep 3, 2024 · 4df7097 · 4df7097
1 parent 7fccd88
commit 4df7097
Show file tree

Hide file tree

Showing 98 changed files with 15,060 additions and 12,241 deletions.
diff --git a/scripts/generate-site-examples.js b/scripts/generate-site-examples.js
@@ -187,7 +187,7 @@ function writeSiteExample(state) {
       <div style={{ marginBottom: '1em' }}>
         <Playground code={${codeVariable}} setupCode={exampleSetup} />
       </div>
-    `)
+    `),
   )
 
   const moreExamples = buildMoreExamplesMarkdown(category)
@@ -208,7 +208,7 @@ function buildMoreExamplesMarkdown(category) {
   }
 
   const lines = [
-    ':::info More examples',
+    ':::info[More examples]',
     'The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),',
     'but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always',
     'just one hover away!',
@@ -220,7 +220,7 @@ function buildMoreExamplesMarkdown(category) {
     lines.push(` - [${linkName}](${links[linkName]})`)
   }
 
-  lines.push(':::')
+  lines.push(':::\n')
 
   return lines.join('\n')
 }
@@ -238,7 +238,7 @@ function addCodeLine(state) {
 
   if (!code) {
     console.error(
-      `found invalid code block in a site example in ${state.filePath}:${state.lineIndex}`
+      `found invalid code block in a site example in ${state.filePath}:${state.lineIndex}`,
     )
 
     process.exit(1)
@@ -260,7 +260,7 @@ function addCommentLine(state) {
 
   if (!comment) {
     console.error(
-      `found invalid comment in a site example in ${state.filePath}:${state.lineIndex}`
+      `found invalid comment in a site example in ${state.filePath}:${state.lineIndex}`,
     )
 
     process.exit(1)
@@ -278,7 +278,7 @@ function enterExample(state) {
 
   if (!state.annotation) {
     console.error(
-      `found invalid site example annotation in ${state.filePath}:${state.lineIndex}`
+      `found invalid site example annotation in ${state.filePath}:${state.lineIndex}`,
     )
 
     process.exit(1)

diff --git a/site/docs/examples/DELETE/_category_.json b/site/docs/examples/DELETE/_category_.json
diff --git a/site/docs/examples/INSERT/_category_.json b/site/docs/examples/INSERT/_category_.json
diff --git a/site/docs/examples/JOIN/_category_.json b/site/docs/examples/JOIN/_category_.json
diff --git a/site/docs/examples/SELECT/_category_.json b/site/docs/examples/SELECT/_category_.json
diff --git a/site/docs/examples/UPDATE/_category_.json b/site/docs/examples/UPDATE/_category_.json
diff --git a/site/docs/examples/cte/_category_.json b/site/docs/examples/cte/_category_.json
@@ -3,6 +3,6 @@
   "position": 7,
   "link": {
     "type": "generated-index",
-    "description": "Short and simple examples of how to use common table expressions (CTE) in queries."
+    "description": "Short and simple examples of how to use Common Table Expressions (CTE) in queries."
   }
 }
diff --git a/site/docs/examples/DELETE/0010-single-row.js → site/docs/examples/delete/0010-single-row.js b/site/docs/examples/DELETE/0010-single-row.js → site/docs/examples/delete/0010-single-row.js
diff --git a/.../docs/examples/DELETE/0010-single-row.mdx → .../docs/examples/delete/0010-single-row.mdx b/.../docs/examples/DELETE/0010-single-row.mdx → .../docs/examples/delete/0010-single-row.mdx
@@ -19,12 +19,12 @@ import {
   <Playground code={singleRow} setupCode={exampleSetup} />
 </div>
 
-:::info More examples
+:::info[More examples]
 The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
 but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
 just one hover away!
 
 For example, check out these sections:
  - [deleteFrom method](https://kysely-org.github.io/kysely-apidoc/classes/Kysely.html#deleteFrom)
  - [returning method](https://kysely-org.github.io/kysely-apidoc/classes/DeleteQueryBuilder.html#returning)
-:::
+:::
diff --git a/site/docs/examples/delete/_category_.json b/site/docs/examples/delete/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "DELETE",
+  "position": 6,
+  "link": {
+    "type": "generated-index",
+    "description": "Short and simple examples of how to write DELETE queries."
+  }
+}
diff --git a/site/docs/examples/INSERT/0010-single-row.js → site/docs/examples/insert/0010-single-row.js b/site/docs/examples/INSERT/0010-single-row.js → site/docs/examples/insert/0010-single-row.js
diff --git a/.../docs/examples/INSERT/0010-single-row.mdx → .../docs/examples/insert/0010-single-row.mdx b/.../docs/examples/INSERT/0010-single-row.mdx → .../docs/examples/insert/0010-single-row.mdx
@@ -19,7 +19,7 @@ import {
   <Playground code={singleRow} setupCode={exampleSetup} />
 </div>
 
-:::info More examples
+:::info[More examples]
 The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
 but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
 just one hover away!
@@ -29,4 +29,4 @@ For example, check out these sections:
  - [onConflict method](https://kysely-org.github.io/kysely-apidoc/classes/InsertQueryBuilder.html#onConflict)
  - [returning method](https://kysely-org.github.io/kysely-apidoc/classes/InsertQueryBuilder.html#returning)
  - [insertInto method](https://kysely-org.github.io/kysely-apidoc/classes/Kysely.html#insertInto)
-:::
+:::
diff --git a/...ocs/examples/INSERT/0020-multiple-rows.js → ...ocs/examples/insert/0020-multiple-rows.js b/...ocs/examples/INSERT/0020-multiple-rows.js → ...ocs/examples/insert/0020-multiple-rows.js
diff --git a/...cs/examples/INSERT/0020-multiple-rows.mdx → ...cs/examples/insert/0020-multiple-rows.mdx b/...cs/examples/INSERT/0020-multiple-rows.mdx → ...cs/examples/insert/0020-multiple-rows.mdx
@@ -22,7 +22,7 @@ import {
   <Playground code={multipleRows} setupCode={exampleSetup} />
 </div>
 
-:::info More examples
+:::info[More examples]
 The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
 but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
 just one hover away!
@@ -32,4 +32,4 @@ For example, check out these sections:
  - [onConflict method](https://kysely-org.github.io/kysely-apidoc/classes/InsertQueryBuilder.html#onConflict)
  - [returning method](https://kysely-org.github.io/kysely-apidoc/classes/InsertQueryBuilder.html#returning)
  - [insertInto method](https://kysely-org.github.io/kysely-apidoc/classes/Kysely.html#insertInto)
-:::
+:::
diff --git a/...cs/examples/INSERT/0030-returning-data.js → ...cs/examples/insert/0030-returning-data.js b/...cs/examples/INSERT/0030-returning-data.js → ...cs/examples/insert/0030-returning-data.js
diff --git a/...s/examples/INSERT/0030-returning-data.mdx → ...s/examples/insert/0030-returning-data.mdx b/...s/examples/INSERT/0030-returning-data.mdx → ...s/examples/insert/0030-returning-data.mdx
@@ -22,7 +22,7 @@ import {
   <Playground code={returningData} setupCode={exampleSetup} />
 </div>
 
-:::info More examples
+:::info[More examples]
 The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
 but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
 just one hover away!
@@ -32,4 +32,4 @@ For example, check out these sections:
  - [onConflict method](https://kysely-org.github.io/kysely-apidoc/classes/InsertQueryBuilder.html#onConflict)
  - [returning method](https://kysely-org.github.io/kysely-apidoc/classes/InsertQueryBuilder.html#returning)
  - [insertInto method](https://kysely-org.github.io/kysely-apidoc/classes/Kysely.html#insertInto)
-:::
+:::
diff --git a/...cs/examples/INSERT/0040-complex-values.js → ...cs/examples/insert/0040-complex-values.js b/...cs/examples/INSERT/0040-complex-values.js → ...cs/examples/insert/0040-complex-values.js
diff --git a/...s/examples/INSERT/0040-complex-values.mdx → ...s/examples/insert/0040-complex-values.mdx b/...s/examples/INSERT/0040-complex-values.mdx → ...s/examples/insert/0040-complex-values.mdx
@@ -21,7 +21,7 @@ import {
   <Playground code={complexValues} setupCode={exampleSetup} />
 </div>
 
-:::info More examples
+:::info[More examples]
 The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
 but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
 just one hover away!
@@ -31,4 +31,4 @@ For example, check out these sections:
  - [onConflict method](https://kysely-org.github.io/kysely-apidoc/classes/InsertQueryBuilder.html#onConflict)
  - [returning method](https://kysely-org.github.io/kysely-apidoc/classes/InsertQueryBuilder.html#returning)
  - [insertInto method](https://kysely-org.github.io/kysely-apidoc/classes/Kysely.html#insertInto)
-:::
+:::
diff --git a/...s/examples/INSERT/0050-insert-subquery.js → ...s/examples/insert/0050-insert-subquery.js b/...s/examples/INSERT/0050-insert-subquery.js → ...s/examples/insert/0050-insert-subquery.js
diff --git a/.../examples/INSERT/0050-insert-subquery.mdx → .../examples/insert/0050-insert-subquery.mdx b/.../examples/INSERT/0050-insert-subquery.mdx → .../examples/insert/0050-insert-subquery.mdx
@@ -21,7 +21,7 @@ import {
   <Playground code={insertSubquery} setupCode={exampleSetup} />
 </div>
 
-:::info More examples
+:::info[More examples]
 The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
 but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
 just one hover away!
@@ -31,4 +31,4 @@ For example, check out these sections:
  - [onConflict method](https://kysely-org.github.io/kysely-apidoc/classes/InsertQueryBuilder.html#onConflict)
  - [returning method](https://kysely-org.github.io/kysely-apidoc/classes/InsertQueryBuilder.html#returning)
  - [insertInto method](https://kysely-org.github.io/kysely-apidoc/classes/Kysely.html#insertInto)
-:::
+:::
diff --git a/site/docs/examples/insert/_category_.json b/site/docs/examples/insert/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "INSERT",
+  "position": 4,
+  "link": {
+    "type": "generated-index",
+    "description": "Short and simple examples of how to write INSERT queries."
+  }
+}
diff --git a/...s/examples/JOIN/0010-simple-inner-join.js → ...s/examples/join/0010-simple-inner-join.js b/...s/examples/JOIN/0010-simple-inner-join.js → ...s/examples/join/0010-simple-inner-join.js
diff --git a/.../examples/JOIN/0010-simple-inner-join.mdx → .../examples/join/0010-simple-inner-join.mdx b/.../examples/JOIN/0010-simple-inner-join.mdx → .../examples/join/0010-simple-inner-join.mdx
@@ -19,7 +19,7 @@ import {
   <Playground code={simpleInnerJoin} setupCode={exampleSetup} />
 </div>
 
-:::info More examples
+:::info[More examples]
 The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
 but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
 just one hover away!
@@ -29,4 +29,4 @@ For example, check out these sections:
  - [leftJoin method](https://kysely-org.github.io/kysely-apidoc/interfaces/SelectQueryBuilder.html#leftJoin)
  - [rightJoin method](https://kysely-org.github.io/kysely-apidoc/interfaces/SelectQueryBuilder.html#rightJoin)
  - [fullJoin method](https://kysely-org.github.io/kysely-apidoc/interfaces/SelectQueryBuilder.html#fullJoin)
-:::
+:::
diff --git a/.../examples/JOIN/0020-aliased-inner-join.js → .../examples/join/0020-aliased-inner-join.js b/.../examples/JOIN/0020-aliased-inner-join.js → .../examples/join/0020-aliased-inner-join.js
diff --git a/...examples/JOIN/0020-aliased-inner-join.mdx → ...examples/join/0020-aliased-inner-join.mdx b/...examples/JOIN/0020-aliased-inner-join.mdx → ...examples/join/0020-aliased-inner-join.mdx
@@ -19,7 +19,7 @@ import {
   <Playground code={aliasedInnerJoin} setupCode={exampleSetup} />
 </div>
 
-:::info More examples
+:::info[More examples]
 The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
 but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
 just one hover away!
@@ -29,4 +29,4 @@ For example, check out these sections:
  - [leftJoin method](https://kysely-org.github.io/kysely-apidoc/interfaces/SelectQueryBuilder.html#leftJoin)
  - [rightJoin method](https://kysely-org.github.io/kysely-apidoc/interfaces/SelectQueryBuilder.html#rightJoin)
  - [fullJoin method](https://kysely-org.github.io/kysely-apidoc/interfaces/SelectQueryBuilder.html#fullJoin)
-:::
+:::
diff --git a/site/docs/examples/JOIN/0030-complex-join.js → site/docs/examples/join/0030-complex-join.js b/site/docs/examples/JOIN/0030-complex-join.js → site/docs/examples/join/0030-complex-join.js
diff --git a/.../docs/examples/JOIN/0030-complex-join.mdx → .../docs/examples/join/0030-complex-join.mdx b/.../docs/examples/JOIN/0030-complex-join.mdx → .../docs/examples/join/0030-complex-join.mdx
@@ -27,7 +27,7 @@ import {
   <Playground code={complexJoin} setupCode={exampleSetup} />
 </div>
 
-:::info More examples
+:::info[More examples]
 The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
 but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
 just one hover away!
@@ -37,4 +37,4 @@ For example, check out these sections:
  - [leftJoin method](https://kysely-org.github.io/kysely-apidoc/interfaces/SelectQueryBuilder.html#leftJoin)
  - [rightJoin method](https://kysely-org.github.io/kysely-apidoc/interfaces/SelectQueryBuilder.html#rightJoin)
  - [fullJoin method](https://kysely-org.github.io/kysely-apidoc/interfaces/SelectQueryBuilder.html#fullJoin)
-:::
+:::
diff --git a/.../docs/examples/JOIN/0040-subquery-join.js → .../docs/examples/join/0040-subquery-join.js b/.../docs/examples/JOIN/0040-subquery-join.js → .../docs/examples/join/0040-subquery-join.js
diff --git a/...docs/examples/JOIN/0040-subquery-join.mdx → ...docs/examples/join/0040-subquery-join.mdx b/...docs/examples/JOIN/0040-subquery-join.mdx → ...docs/examples/join/0040-subquery-join.mdx
@@ -19,7 +19,7 @@ import {
   <Playground code={subqueryJoin} setupCode={exampleSetup} />
 </div>
 
-:::info More examples
+:::info[More examples]
 The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
 but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
 just one hover away!
@@ -29,4 +29,4 @@ For example, check out these sections:
  - [leftJoin method](https://kysely-org.github.io/kysely-apidoc/interfaces/SelectQueryBuilder.html#leftJoin)
  - [rightJoin method](https://kysely-org.github.io/kysely-apidoc/interfaces/SelectQueryBuilder.html#rightJoin)
  - [fullJoin method](https://kysely-org.github.io/kysely-apidoc/interfaces/SelectQueryBuilder.html#fullJoin)
-:::
+:::
diff --git a/site/docs/examples/join/_category_.json b/site/docs/examples/join/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "JOIN",
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "description": "Examples of queries that use JOINs."
+  }
+}
diff --git a/...s/examples/SELECT/0010-a-single-column.js → ...s/examples/select/0010-a-single-column.js b/...s/examples/SELECT/0010-a-single-column.js → ...s/examples/select/0010-a-single-column.js
diff --git a/.../examples/SELECT/0010-a-single-column.mdx → .../examples/select/0010-a-single-column.mdx b/.../examples/SELECT/0010-a-single-column.mdx → .../examples/select/0010-a-single-column.mdx
@@ -19,7 +19,7 @@ import {
   <Playground code={aSingleColumn} setupCode={exampleSetup} />
 </div>
 
-:::info More examples
+:::info[More examples]
 The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
 but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
 just one hover away!
@@ -28,4 +28,4 @@ For example, check out these sections:
  - [select method](https://kysely-org.github.io/kysely-apidoc/interfaces/SelectQueryBuilder.html#select)
  - [selectAll method](https://kysely-org.github.io/kysely-apidoc/interfaces/SelectQueryBuilder.html#selectAll)
  - [selectFrom method](https://kysely-org.github.io/kysely-apidoc/classes/Kysely.html#selectFrom)
-:::
+:::
diff --git a/...amples/SELECT/0020-column-with-a-table.js → ...amples/select/0020-column-with-a-table.js b/...amples/SELECT/0020-column-with-a-table.js → ...amples/select/0020-column-with-a-table.js
diff --git a/...mples/SELECT/0020-column-with-a-table.mdx → ...mples/select/0020-column-with-a-table.mdx b/...mples/SELECT/0020-column-with-a-table.mdx → ...mples/select/0020-column-with-a-table.mdx
@@ -19,7 +19,7 @@ import {
   <Playground code={columnWithATable} setupCode={exampleSetup} />
 </div>
 
-:::info More examples
+:::info[More examples]
 The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
 but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
 just one hover away!
@@ -28,4 +28,4 @@ For example, check out these sections:
  - [select method](https://kysely-org.github.io/kysely-apidoc/interfaces/SelectQueryBuilder.html#select)
  - [selectAll method](https://kysely-org.github.io/kysely-apidoc/interfaces/SelectQueryBuilder.html#selectAll)
  - [selectFrom method](https://kysely-org.github.io/kysely-apidoc/classes/Kysely.html#selectFrom)
-:::
+:::
diff --git a/.../examples/SELECT/0030-multiple-columns.js → .../examples/select/0030-multiple-columns.js b/.../examples/SELECT/0030-multiple-columns.js → .../examples/select/0030-multiple-columns.js
diff --git a/...examples/SELECT/0030-multiple-columns.mdx → ...examples/select/0030-multiple-columns.mdx b/...examples/SELECT/0030-multiple-columns.mdx → ...examples/select/0030-multiple-columns.mdx
@@ -19,7 +19,7 @@ import {
   <Playground code={multipleColumns} setupCode={exampleSetup} />
 </div>
 
-:::info More examples
+:::info[More examples]
 The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
 but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
 just one hover away!
@@ -28,4 +28,4 @@ For example, check out these sections:
  - [select method](https://kysely-org.github.io/kysely-apidoc/interfaces/SelectQueryBuilder.html#select)
  - [selectAll method](https://kysely-org.github.io/kysely-apidoc/interfaces/SelectQueryBuilder.html#selectAll)
  - [selectFrom method](https://kysely-org.github.io/kysely-apidoc/classes/Kysely.html#selectFrom)
-:::
+:::
diff --git a/site/docs/examples/SELECT/0040-aliases.js → site/docs/examples/select/0040-aliases.js b/site/docs/examples/SELECT/0040-aliases.js → site/docs/examples/select/0040-aliases.js
diff --git a/site/docs/examples/SELECT/0040-aliases.mdx → site/docs/examples/select/0040-aliases.mdx b/site/docs/examples/SELECT/0040-aliases.mdx → site/docs/examples/select/0040-aliases.mdx
@@ -19,7 +19,7 @@ import {
   <Playground code={aliases} setupCode={exampleSetup} />
 </div>
 
-:::info More examples
+:::info[More examples]
 The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
 but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
 just one hover away!
@@ -28,4 +28,4 @@ For example, check out these sections:
  - [select method](https://kysely-org.github.io/kysely-apidoc/interfaces/SelectQueryBuilder.html#select)
  - [selectAll method](https://kysely-org.github.io/kysely-apidoc/interfaces/SelectQueryBuilder.html#selectAll)
  - [selectFrom method](https://kysely-org.github.io/kysely-apidoc/classes/Kysely.html#selectFrom)
-:::
+:::
diff --git a/...xamples/SELECT/0050-complex-selections.js → ...xamples/select/0050-complex-selections.js b/...xamples/SELECT/0050-complex-selections.js → ...xamples/select/0050-complex-selections.js
diff --git a/...amples/SELECT/0050-complex-selections.mdx → ...amples/select/0050-complex-selections.mdx b/...amples/SELECT/0050-complex-selections.mdx → ...amples/select/0050-complex-selections.mdx
@@ -20,7 +20,7 @@ import {
   <Playground code={complexSelections} setupCode={exampleSetup} />
 </div>
 
-:::info More examples
+:::info[More examples]
 The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
 but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
 just one hover away!
@@ -29,4 +29,4 @@ For example, check out these sections:
  - [select method](https://kysely-org.github.io/kysely-apidoc/interfaces/SelectQueryBuilder.html#select)
  - [selectAll method](https://kysely-org.github.io/kysely-apidoc/interfaces/SelectQueryBuilder.html#selectAll)
  - [selectFrom method](https://kysely-org.github.io/kysely-apidoc/classes/Kysely.html#selectFrom)
-:::
+:::
diff --git a/site/docs/examples/SELECT/0051-not-null.js → site/docs/examples/select/0051-not-null.js b/site/docs/examples/SELECT/0051-not-null.js → site/docs/examples/select/0051-not-null.js