fix: doc build

tiddly-gittly · Dec 30, 2023 · d74d8fd · d74d8fd
1 parent 7765004
commit d74d8fd
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 213 deletions.
diff --git a/.gitignore b/.gitignore
@@ -16,4 +16,6 @@ test/mockRepo
 test/mockRepo2
 test/mockUpstreamRepo
 docs/api
-.docusaurus
+docs/README.md
+.docusaurus
+build
diff --git a/docs/README.md b/docs/README.md
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
@@ -62,9 +62,9 @@ export default {
         items: [
           {
             type: 'doc',
-            docId: 'api-summary',
+            docId: 'README',
             position: 'left',
-            label: 'Tutorial',
+            label: 'README',
           },
           { to: 'api', label: 'API', position: 'left' },
           {
@@ -81,8 +81,8 @@ export default {
             title: 'Docs',
             items: [
               {
-                label: 'Tutorial',
-                to: 'api-summary',
+                label: 'README',
+                to: 'README',
               },
             ],
           },

diff --git a/package.json b/package.json
@@ -42,6 +42,7 @@
     "@docusaurus/core": "^3.0.1",
     "@docusaurus/preset-classic": "^3.0.1",
     "@docusaurus/types": "^3.0.1",
+    "@mdx-js/react": "^3.0.0",
     "@types/fs-extra": "^11.0.4",
     "@types/jest": "^29.5.11",
     "@types/lodash": "^4.14.202",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml