chore(docs): moved api docs

typedoc2md · Dec 30, 2024 · 75cf255 · 75cf255
1 parent 2addf78
commit 75cf255
Show file tree

Hide file tree

Showing 36 changed files with 573 additions and 1,684 deletions.
diff --git a/devtools/packages/prebuild-options/tasks/generate-docs.ts b/devtools/packages/prebuild-options/tasks/generate-docs.ts
@@ -156,13 +156,13 @@ ${presetsJson}
 
       options.forEach((option) => {
         optionsTable.push(
-          `| [\`${option.name}\`](./options/${categoryName.toLowerCase()}-options.mdx#--${option.name.toLowerCase()}) | ${
+          `| [\`${option.name}\`](./options/${categoryName.toLowerCase()}-options.mdx#${option.name.toLowerCase()}) | ${
             option.help
           } |`,
         );
         out.push(
           `${optionLevel} ${
-            option.deprecated ? `~--${option.name}~` : `--${option.name}`
+            option.deprecated ? `~${option.name}~` : `${option.name}`
           }`,
         );
         if (option.deprecated) {

diff --git a/docs/global.css b/docs/global.css
@@ -8,7 +8,6 @@
 .nextra-toc a[href^='#source'],
 .nextra-toc a[href^='#overrides'],
 .nextra-toc a[href^='#see'],
-.nextra-toc a[href^='#example'],
 .nextra-toc a[href^='#new-features'],
 .nextra-toc a[href^='#bug-fixes'],
 .nextra-toc a[href^='#minor-changes'],

diff --git a/docs/next-env.d.ts b/docs/next-env.d.ts
@@ -2,4 +2,4 @@
 /// <reference types="next/image-types/global" />
 
 // NOTE: This file should not be edited
-// see https://nextjs.org/docs/pages/building-your-application/configuring/typescript for more information.
+// see https://nextjs.org/docs/pages/api-reference/config/typescript for more information.
diff --git a/docs/package-lock.json b/docs/package-lock.json
diff --git a/docs/package.json b/docs/package.json
@@ -15,24 +15,24 @@
   },
   "author": "Thomas Grey",
   "dependencies": {
-    "@fortawesome/fontawesome-svg-core": "^6.7.1",
-    "@fortawesome/free-brands-svg-icons": "^6.7.1",
-    "@fortawesome/free-solid-svg-icons": "^6.7.1",
+    "@fortawesome/fontawesome-svg-core": "^6.7.2",
+    "@fortawesome/free-brands-svg-icons": "^6.7.2",
+    "@fortawesome/free-solid-svg-icons": "^6.7.2",
     "@fortawesome/react-fontawesome": "^0.2.2",
     "@vercel/analytics": "^1.4.1",
-    "next": "^15.0.3",
-    "nextra": "3.2.4",
-    "nextra-theme-docs": "3.2.4",
-    "react": "^18.3.1",
-    "react-dom": "^18.3.1"
+    "next": "^15.1.3",
+    "nextra": "3.3.1",
+    "nextra-theme-docs": "3.3.1",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0"
   },
   "devDependencies": {
-    "@types/node": "^22.10.1",
+    "@types/node": "^22.10.2",
     "autoprefixer": "^10.4.20",
     "copyfiles": "^2.4.1",
-    "eslint": "^9.16.0",
+    "eslint": "^9.17.0",
     "postcss": "^8.4.49",
-    "tailwindcss": "^3.4.16"
+    "tailwindcss": "^3.4.17"
   },
   "postcss": {
     "plugins": {

diff --git a/docs/pages/_meta.js b/docs/pages/_meta.js
@@ -18,8 +18,4 @@ export default {
     title: 'Utils & Themes',
     type: 'page',
   },
-  'api-docs': {
-    type: 'page',
-    title: 'API',
-  },
 };
diff --git a/docs/pages/api-docs/Class.MarkdownPageEvent.mdx b/docs/pages/api-docs/Class.MarkdownPageEvent.mdx
diff --git a/docs/pages/api-docs/Class.MarkdownRendererEvent.mdx b/docs/pages/api-docs/Class.MarkdownRendererEvent.mdx
diff --git a/docs/pages/api-docs/Document.Customizing-Output.mdx b/docs/pages/api-docs/Document.Customizing-Output.mdx
diff --git a/docs/pages/api-docs/Document.Local-Plugins.mdx b/docs/pages/api-docs/Document.Local-Plugins.mdx
diff --git a/docs/pages/api-docs/Interface.MarkdownApplication.mdx b/docs/pages/api-docs/Interface.MarkdownApplication.mdx