docs: update docs build

docs/docs/usage/02-configuration_files.md

@@ -23,7 +23,7 @@ module.exports = {
 }
 ```
 
-For the full configuration options, see [ScaffoldConfigFile](../api/modules#scaffoldconfigfile).
+For the full configuration options, see [ScaffoldConfigFile](../api/type-aliases/ScaffoldConfigFile).
 
 If you want to supply functions inside the configurations, you must use a `.js`/`.cjs`/`.mjs` file
 as JSON does not support non-primitives.

docs/docusaurus.config.ts

@@ -19,7 +19,12 @@ const config: Config = {
   projectName: "simple-scaffold", // Usually your repo name.
 
   onBrokenLinks: "warn",
-  onBrokenMarkdownLinks: "warn",
+
+  markdown: {
+    hooks: {
+      onBrokenMarkdownLinks: "warn",
+    },
+  },
 
   // Even if you don't use internationalization, you can use this field to set
   // useful metadata like html lang. For example, if your site is Chinese, you
@@ -47,8 +52,12 @@ const config: Config = {
         categorizeByGroup: false,
         sort: ["visibility"],
         categoryOrder: ["Main", "*"],
-        media: "media",
         entryPointStrategy: "expand",
+        pageTitleTemplates: {
+          index: "{projectName}",
+          member: "`{rawName}`",
+          module: "{name}",
+        },
         validation: {
           invalidLink: true,
         },
@@ -134,8 +143,12 @@ const config: Config = {
           title: "Docs",
           items: [
             {
-              label: "Tutorial",
-              to: "/docs/intro",
+              label: "Usage",
+              to: "/docs/usage",
+            },
+            {
+              label: "API",
+              to: "/docs/api",
             },
           ],
         },

docs/package.json

@@ -15,23 +15,23 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@docusaurus/core": "3.1.1",
-    "@docusaurus/plugin-google-tag-manager": "^3.1.1",
-    "@docusaurus/preset-classic": "3.1.1",
-    "@mdx-js/react": "^3.0.0",
-    "clsx": "^2.1.0",
-    "prism-react-renderer": "^2.3.1",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0"
+    "@docusaurus/core": "^3.9.2",
+    "@docusaurus/plugin-google-tag-manager": "^3.9.2",
+    "@docusaurus/preset-classic": "^3.9.2",
+    "@mdx-js/react": "^3.1.1",
+    "clsx": "^2.1.1",
+    "prism-react-renderer": "^2.4.1",
+    "react": "^19.2.4",
+    "react-dom": "^19.2.4"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.1.1",
-    "@docusaurus/tsconfig": "3.1.1",
-    "@docusaurus/types": "3.1.1",
-    "docusaurus-plugin-typedoc": "^0.22.0",
-    "typedoc": "^0.25.7",
-    "typedoc-plugin-markdown": "^3.17.1",
-    "typescript": "~5.2.2"
+    "@docusaurus/module-type-aliases": "^3.9.2",
+    "@docusaurus/tsconfig": "^3.9.2",
+    "@docusaurus/types": "^3.9.2",
+    "docusaurus-plugin-typedoc": "^1.4.2",
+    "typedoc": "^0.28.18",
+    "typedoc-plugin-markdown": "^4.11.0",
+    "typescript": "~5.9.3"
   },
   "browserslist": {
     "production": [

docs/sidebars.ts

@@ -1,51 +1,28 @@
 import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"
 
-/**
- * Creating a sidebar enables you to:
- - create an ordered group of docs
- - render a sidebar for each doc of that group
- - provide next/previous navigation
-
- The sidebars can be generated from the filesystem, or explicitly defined here.
-
- Create as many sidebars as you want.
- */
 const sidebars: SidebarsConfig = {
-  // By default, Docusaurus generates a sidebar from the docs folder structure
-  // docs: [{ type: "autogenerated", dirName: "." }],
-  usage: ["usage/index"],
-  api: ["api/index"],
-  docs: [{ type: "autogenerated", dirName: "." }],
-  // docs: [
-  //   {
-  //     type: "category",
-  //     label: "Guides",
-  //     link: {
-  //       type: "generated-index",
-  //       title: "Docusaurus Guides",
-  //       description: "Learn about the most important Docusaurus concepts!",
-  //       slug: "/category/docusaurus-guides",
-  //       keywords: ["guides"],
-  //       image: "/img/docusaurus.png",
-  //     },
-  //     items: ["pages", "docs", "blog", "search"],
-  //   },
-  // ],
-  // usage: [{ type: "autogenerated", dirName: "usage" }],
-  // api: [{ type: "autogenerated", dirName: "api" }],
-
-  // But you can create a sidebar manually
-  /*
-  tutorialSidebar: [
-    'intro',
-    'hello',
+  usage: [{ type: "autogenerated", dirName: "usage" }],
+  api: [
+    "api/index",
     {
-      type: 'category',
-      label: 'Tutorial',
-      items: ['tutorial-basics/create-a-document'],
+      type: "category",
+      label: "Functions",
+      items: [{ type: "autogenerated", dirName: "api/functions" }],
+    },
+    {
+      type: "category",
+      label: "Types",
+      items: [
+        { type: "autogenerated", dirName: "api/interfaces" },
+        { type: "autogenerated", dirName: "api/type-aliases" },
+      ],
+    },
+    {
+      type: "category",
+      label: "Variables",
+      items: [{ type: "autogenerated", dirName: "api/variables" }],
     },
   ],
-   */
 }
 
 export default sidebars