📝upgrade website to docusaurus v3 (#1072)

graphql-markdown · Nov 1, 2023 · 6b9d152 · 6b9d152
1 parent a5078ed
commit 6b9d152
Show file tree

Hide file tree

Showing 8 changed files with 5,679 additions and 3,350 deletions.
diff --git a/.github/workflows/publish-docs.yaml b/.github/workflows/publish-docs.yaml
@@ -53,7 +53,7 @@ jobs:
           cd package
           npm ci
           npm run docs:api
-          earthly +build-docs
+          earthly --build-arg VERSION=3 +build-docs
 
       - name: Push changes to website repo
         run: |

diff --git a/Earthfile b/Earthfile
@@ -111,7 +111,7 @@ build-examples:
 build-docs:
   ARG VERSION=latest
   COPY ./website ./
-  COPY +build-examples/examples --VERSION=$VERSION ./examples
+  COPY (+build-examples/examples --VERSION=$VERSION) ./examples
   COPY --dir docs .
   COPY --dir api .
   RUN npm install

diff --git a/docs/settings.md b/docs/settings.md
@@ -93,9 +93,9 @@ plugins: [
 
 Use a GraphQL directive for creating documentation categories (see [documentation categories](/docs/advanced/group-by-directive)).
 
-| Setting            | CLI flag                                                                 | Default     |
-| ------------------ | ------------------------------------------------------------------------ | ----------- |
-| `groupByDirective` | <code>-gdb, --groupByDirective <@directive(field&#124;=fallback)></code> | `undefined` |
+| Setting            | CLI flag                                                                        | Default     |
+| ------------------ | ------------------------------------------------------------------------------- | ----------- |
+| `groupByDirective` | <code>-gdb, --groupByDirective &lt;&#64;directive(field&#124;=fallback)></code> | `undefined` |
 
 ## `homepage`
 

diff --git a/packages/utils/src/array.ts b/packages/utils/src/array.ts
@@ -1,5 +1,5 @@
 /**
- * Internal library of helpers for converting array \<-\> list.
+ * Internal library of helpers for manipulating array and list.
  *
  * @packageDocumentation
  */

diff --git a/typedoc.base.json b/typedoc.base.json
@@ -15,7 +15,6 @@
   "useCodeBlocks": true,
   "outputFileStrategy": "modules",
   "pretty": true,
-  "mergeReadme": true,
   "theme": "default",
   "visibilityFilters": {},
   "validation": {

diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -1,8 +1,8 @@
 // @ts-nocheck
 // Note: type annotations allow type checking and IDEs autocompletion
 
-const lightCodeTheme = require("prism-react-renderer/themes/github");
-const darkCodeTheme = require("prism-react-renderer/themes/dracula");
+const { themes } =  require("prism-react-renderer");
+const lightCodeTheme = themes.github, darkCodeTheme = themes.dracula;
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
@@ -26,7 +26,7 @@ const config = {
         id: "example-default",
         path: "./examples/default",
         routeBasePath: "examples/default",
-        sidebarPath: require.resolve("./examples/default/sidebar-schema.js"),
+        sidebarPath: "./examples/default/sidebar-schema.js",
       },
     ],
     [
@@ -35,7 +35,7 @@ const config = {
         id: "example-group-by",
         path: "./examples/group-by",
         routeBasePath: "examples/group-by",
-        sidebarPath: require.resolve("./examples/group-by/sidebar-schema.js"),
+        sidebarPath: "./examples/group-by/sidebar-schema.js",
       },
     ],
     [
@@ -54,13 +54,13 @@ const config = {
       /** @type {import('@docusaurus/preset-classic').Options} */
       ({
         docs: {
-          sidebarPath: require.resolve("./sidebars.js"),
+          sidebarPath: "./sidebars.js",
           editUrl:
             "https://github.com/graphql-markdown/graphql-markdown/tree/main/",
           exclude: ["**/__*.md"],
         },
         theme: {
-          customCss: [require.resolve("./src/css/custom.css")],
+          customCss: ["./src/css/custom.css"],
         },
         sitemap: {
           changefreq: "monthly",