docs: fix links

Author: posva

docs/.vitepress/config.ts

@@ -18,14 +18,18 @@ export default defineConfig({
 
   markdown: {
     theme: {
-      dark: 'dracula-soft',
-      light: 'vitesse-light',
+      dark: 'one-dark-pro',
+      light: 'github-light',
     },
 
     attrs: {
       leftDelimiter: '%{',
       rightDelimiter: '}%',
     },
+
+    anchor: {
+      slugify: (s: string) => s.replace(/\s+/g, '-'),
+    },
   },
 
   head: [

docs/nuxt/getting-started.md

@@ -69,7 +69,7 @@ If you are using SSR with any auth related feature, you will need to create a [s
 
 In local development it's more convenient to put the `service-account.json` file alongside other files and refer to its path in the environment variable:
 
-```dotenv
+```text
 GOOGLE_APPLICATION_CREDENTIALS=service-account.json
 ```
 

package.json

@@ -102,7 +102,7 @@
     "prettier": "^2.8.8",
     "semver": "^7.5.4",
     "typedoc": "^0.24.8",
-    "typedoc-plugin-markdown": "^3.15.3",
+    "typedoc-plugin-markdown": "^3.15.4",
     "typescript": "~5.1.6",
     "unbuild": "^1.2.1",
     "vitepress": "1.0.0-beta.7",

playground/package.json

@@ -26,7 +26,7 @@
     "npm-run-all": "^4.1.5",
     "typescript": "~5.1.6",
     "unplugin-vue-router": "^0.6.4",
-    "vite": "^4.4.3",
+    "vite": "^4.4.8",
     "vue-tsc": "^1.8.4"
   }
 }

pnpm-lock.yaml

@@ -6,7 +6,7 @@ createTypeDocApp({
   tsconfig: path.resolve(__dirname, './typedoc.tsconfig.json'),
   // entryPointStrategy: 'packages',
   githubPages: false,
-  disableSources: true,
+  disableSources: true, // some links are in node_modules and it's ugly
   plugin: ['typedoc-plugin-markdown'],
   entryPoints: [path.resolve(__dirname, '../src/index.ts')],
 }).build()

scripts/run-typedoc.cjs

@@ -34,9 +34,6 @@ exports.createTypeDocApp = function createTypeDocApp(config = {}) {
   /** @type {'build' | 'serve'} */
   let targetMode = 'build'
 
-  const slugify = (s) => s.replaceAll(' ', '-')
-  // encodeURIComponent(String(s).trim().toLowerCase().replace(/\s+/g, '-'))
-
   app.renderer.on(
     PageEvent.END,
     /**
@@ -46,56 +43,10 @@ exports.createTypeDocApp = function createTypeDocApp(config = {}) {
     (page) => {
       if (page.url !== 'index.md' && page.contents) {
         page.contents = prependYAML(page.contents, {
-          sidebar: 'auto',
           // TODO: figure out a way to point to the source files?
           editLink: false,
-          sidebarDepth: 3,
         })
       }
-
-      // avoid duplicated id titles
-      if (page.contents) {
-        const lines = page.contents.split('\n')
-        const titleStack = []
-        let currentLevel = 0
-        const TITLE_LEVEL = /^#+/
-        const existingIds = new Map()
-        for (let i = 0; i < lines.length; i++) {
-          const line = lines[i]
-          if (!line.startsWith('#')) continue
-          const level = line.match(TITLE_LEVEL)?.[0].length
-          if (level == null) continue
-
-          // remove extra levels
-          if (level <= currentLevel) {
-            titleStack.splice(level - 1)
-          }
-          // add the current title
-          titleStack.push(line.slice(level).trim())
-          currentLevel = level
-
-          // no need to add ids to h1
-          if (level < 2) continue
-
-          // ignore the root level (h1) to match the sidebar
-          const slugifiedTitle = slugify(titleStack.slice(1).join('-'))
-            // ensure the link is valid vuejs/router#1743
-            .replaceAll('\\', '')
-          let id
-          if (existingIds.has(slugifiedTitle)) {
-            const current = existingIds.get(slugifiedTitle)
-            existingIds.set(slugifiedTitle, current + 1)
-            id = ` %{#${slugifiedTitle}_${current + 1}}%`
-          } else {
-            existingIds.set(slugifiedTitle, 0)
-            id = ` %{#${slugifiedTitle}}%`
-          }
-          const newLine = line + id
-          lines.splice(i, 1, newLine)
-        }
-
-        page.contents = lines.join('\n')
-      }
     }
   )
 
@@ -113,15 +64,12 @@ exports.createTypeDocApp = function createTypeDocApp(config = {}) {
     }
     await app.bootstrapWithPlugins(options)
     const project = app.convert()
-    if (!project) {
-      throw new Error('Failed to convert')
-    }
     return handleProject(project)
   }
 
   /**
    *
-   * @param {import('typedoc').ProjectReflection} project
+   * @param {import('typedoc').ProjectReflection | undefined} project
    */
   async function handleProject(project) {
     if (project) {