Remove formatting from link titles

Author: kristijanhusak

.github/workflows/deploy.yml

@@ -23,13 +23,10 @@ jobs:
           node-version: 20
           cache: npm
 
-      - name: Build md files
-        run: npm run pandoc:build
-
       - name: Install dependencies
         run: npm ci
 
-      - name: Build with VitePress
+      - name: Build
         run: npm run docs:build
 
       - name: Deploy

.vitepress/config.mts

@@ -3,6 +3,11 @@ import fs from 'node:fs'
 
 export default async () => {
   const files: string[] = await fs.promises.readdir('./docs_md')
+  const name_maps = {
+    index: 'Home',
+  }
+
+  const sorting = ['Home', 'Installation', 'Configuration', 'Plugins']
 
   // https://vitepress.dev/reference/site-config
   return defineConfig({
@@ -17,19 +22,30 @@ export default async () => {
 
       sidebar: files.filter(file => file.endsWith('.md')).map((file) => {
         const name = file.replace('.md', '')
-        const text = name.slice(0, 1).toUpperCase() + name.slice(1)
+        let text = name.slice(0, 1).toUpperCase() + name.slice(1)
+        text = name_maps[name] || text
         return { text, link: `/${file.replace('.md', '')}` }
+      }).sort((a, b) => {
+        if (sorting.includes(a.text) && sorting.includes(b.text)) {
+          return sorting.indexOf(a.text) - sorting.indexOf(b.text)
+        }
+        if (sorting.includes(a.text)) return -1
+        if (sorting.includes(b.text)) return 1
+        return a.text.localeCompare(b.text)
       }),
 
       socialLinks: [
         { icon: 'github', link: 'https://github.com/nvim-orgmode/orgmode' }
-      ]
+      ],
+      outline: {
+        level: [2 ,3]
+      }
     },
     cleanUrls: true,
     markdown: {
       anchor: {
-        slugify: (s: string) => s.replace(' ', '-').toLowerCase()
-      }
+        slugify: (s: string) => s.replace(' ', '-').replace('.', '').toLowerCase()
+      },
     }
   })
 

package.json

@@ -6,7 +6,8 @@
     "docs:dev": "vitepress dev",
     "docs:build": "vitepress build",
     "docs:preview": "vitepress preview",
-    "pandoc:build": "node ./scripts/generate_md.mjs"
+    "pandoc:build": "node ./scripts/generate_md.mjs",
+    "predocs:dev": "npm run pandoc:build"
   },
   "repository": {
     "type": "git",

scripts/pandoc_fix_links.lua

@@ -5,5 +5,18 @@ function Link(el)
     target = target:gsub('::', '')
   end
   el.target = target
+
+  local content = {}
+  for _, item in ipairs(el.content) do
+    if item.text then
+      table.insert(content, item.text)
+    end
+    if item.content then
+      for _, subitem in ipairs(item.content) do
+        table.insert(content, subitem.text)
+      end
+    end
+  end
+  el.content = table.concat(content, '_')
   return el
 end