Docs revamp

__tests__/e2e/dynamic-routes/[id].md

@@ -1,8 +1,3 @@
-<script setup>
-import { useData } from 'vitepress'
-const { page } = useData()
-</script>
-
 <!-- @content -->
 
-<pre class="params">{{ page.params }}</pre>
+<pre class="params">{{ $params }}</pre>

__tests__/e2e/static-data/static.data.ts

@@ -1,23 +1,20 @@
 import fs from 'fs'
-import path from 'path'
-import { fileURLToPath } from 'url'
-
-const dirname = path.dirname(fileURLToPath(import.meta.url))
+import { defineLoader } from 'vitepress'
 
 type Data = Record<string, boolean>[]
 export declare const data: Data
 
-export default {
+export default defineLoader({
  watch: ['./data/*'],
- async load(): Promise<Data> {
+ async load(files: string[]): Promise<Data> {
  const foo = fs.readFileSync(
- path.resolve(dirname, './data/foo.json'),
+ files.find((f) => f.endsWith('foo.json'))!,
  'utf-8'
  )
  const bar = fs.readFileSync(
- path.resolve(dirname, './data/bar.json'),
+ files.find((f) => f.endsWith('bar.json'))!,
  'utf-8'
  )
  return [JSON.parse(foo), JSON.parse(bar)]
  }
-}
+})

__tests__/unit/client/theme-default/composables/outline.test.ts

@@ -7,14 +7,23 @@ describe('client/theme-default/composables/outline', () => {
  resolveHeaders(
  [
  {
- level: 2,
- title: 'h2 - 1',
- link: '#h2-1'
- },
- {
- level: 3,
- title: 'h3 - 1',
- link: '#h3-1'
+ level: 1,
+ title: 'h1 - 1',
+ link: '#h1-1',
+ children: [
+ {
+ level: 2,
+ title: 'h2 - 1',
+ link: '#h2-1',
+ children: [
+ {
+ level: 3,
+ title: 'h3 - 1',
+ link: '#h3-1'
+ }
+ ]
+ }
+ ]
  }
  ],
  [2, 3]
@@ -42,12 +51,14 @@ describe('client/theme-default/composables/outline', () => {
  {
  level: 2,
  title: 'h2 - 1',
- link: '#h2-1'
- },
- {
- level: 3,
- title: 'h3 - 1',
- link: '#h3-1'
+ link: '#h2-1',
+ children: [
+ {
+ level: 3,
+ title: 'h3 - 1',
+ link: '#h3-1'
+ }
+ ]
  }
  ],
  2
@@ -68,42 +79,52 @@ describe('client/theme-default/composables/outline', () => {
  {
  level: 2,
  title: 'h2 - 1',
- link: '#h2-1'
- },
- {
- level: 3,
- title: 'h3 - 1',
- link: '#h3-1'
- },
- {
- level: 4,
- title: 'h4 - 1',
- link: '#h4-1'
- },
- {
- level: 3,
- title: 'h3 - 2',
- link: '#h3-2'
- },
- {
- level: 4,
- title: 'h4 - 2',
- link: '#h4-2'
+ link: '#h2-1',
+ children: [
+ {
+ level: 3,
+ title: 'h3 - 1',
+ link: '#h3-1',
+ children: [
+ {
+ level: 4,
+ title: 'h4 - 1',
+ link: '#h4-1'
+ }
+ ]
+ },
+ {
+ level: 3,
+ title: 'h3 - 2',
+ link: '#h3-2',
+ children: [
+ {
+ level: 4,
+ title: 'h4 - 2',
+ link: '#h4-2'
+ }
+ ]
+ }
+ ]
  },
  {
  level: 2,
  title: 'h2 - 2',
- link: '#h2-2'
- },
- {
- level: 3,
- title: 'h3 - 3',
- link: '#h3-3'
- },
- {
- level: 4,
- title: 'h4 - 3',
- link: '#h4-3'
+ link: '#h2-2',
+ children: [
+ {
+ level: 3,
+ title: 'h3 - 3',
+ link: '#h3-3',
+ children: [
+ {
+ level: 4,
+ title: 'h4 - 3',
+ link: '#h4-3'
+ }
+ ]
+ }
+ ]
  }
  ],
  'deep'

docs/.vitepress/config.ts

@@ -14,19 +14,12 @@ export default defineConfig({
 
  head: [['meta', { name: 'theme-color', content: '#3c8772' }]],
 
- markdown: {
- headers: {
- level: [0, 0]
- }
- },
-
  themeConfig: {
  nav: nav(),
 
  sidebar: {
  '/guide/': sidebarGuide(),
- '/config/': sidebarConfig(),
- '/api/': sidebarGuide()
+ '/reference/': sidebarReference()
  },
 
  editLink: {
@@ -60,14 +53,9 @@ function nav() {
  return [
  { text: 'Guide', link: '/guide/what-is-vitepress', activeMatch: '/guide/' },
  {
- text: 'Config Reference',
- link: '/config/introduction',
- activeMatch: '/config/'
- },
- {
- text: 'Runtime API',
- link: '/api/',
- activeMatch: '/api/'
+ text: 'Reference',
+ link: '/reference/site-config',
+ activeMatch: '/reference/'
  },
  {
  text: pkg.version,
@@ -93,9 +81,8 @@ function sidebarGuide() {
  items: [
  { text: 'What is VitePress?', link: '/guide/what-is-vitepress' },
  { text: 'Getting Started', link: '/guide/getting-started' },
- { text: 'Configuration', link: '/guide/configuration' },
  { text: 'Routing', link: '/guide/routing' },
- { text: 'Deploying', link: '/guide/deploying' }
+ { text: 'Deploy', link: '/guide/deploy' }
  ]
  },
  {
@@ -113,45 +100,112 @@ function sidebarGuide() {
  text: 'Customization',
  collapsed: false,
  items: [
- // { text: 'Default Theme', link: '/guide/default-theme' },
- // {
- // text: 'Extending the Default Theme',
- // link: '/guide/customization-extending-default-theme'
- // },
- { text: 'Building a Custom Theme', link: '/guide/customization-intro' },
+ { text: 'Using a Custom Theme', link: '/guide/custom-theme' },
  {
- text: 'Runtime API',
- link: '/api/'
+ text: 'Extending the Default Theme',
+ link: '/guide/extending-default-theme'
  },
- { text: 'Build-Time Data Loading', link: '/guide/data-loading' }
+ { text: 'Build-Time Data Loading', link: '/guide/data-loading' },
+ { text: 'Connecting to a CMS', link: '/guide/cms' }
  ]
  },
  {
- text: 'Migrations',
+ text: 'Experimental',
  collapsed: false,
  items: [
  {
- text: 'Migration from VuePress',
- link: '/guide/migration-from-vuepress'
- },
- {
- text: 'Migration from VitePress 0.x',
- link: '/guide/migration-from-vitepress-0'
+ text: 'MPA Mode',
+ link: '/guide/mpa-mode'
  }
  ]
+ },
+ // {
+ // text: 'Migrations',
+ // collapsed: false,
+ // items: [
+ // {
+ // text: 'Migration from VuePress',
+ // link: '/guide/migration-from-vuepress'
+ // },
+ // {
+ // text: 'Migration from VitePress 0.x',
+ // link: '/guide/migration-from-vitepress-0'
+ // }
+ // ]
+ // },
+ {
+ text: 'Config & API Reference',
+ link: '/reference/site-config'
  }
  ]
 }
 
-function sidebarConfig() {
+function sidebarReference() {
  return [
  {
- text: 'Config Reference',
+ text: 'Reference',
  items: [
- { text: 'Introduction', link: '/config/introduction' },
- { text: 'App Config', link: '/config/app-config' },
- { text: 'Default Theme Config', link: '/config/theme-config' },
- { text: 'Frontmatter Config', link: '/config/frontmatter-config' }
+ { text: 'Site Config', link: '/reference/site-config' },
+ { text: 'Frontmatter Config', link: '/reference/frontmatter-config' },
+ { text: 'Runtime API', link: '/reference/runtime-api' },
+ { text: 'CLI', link: '/reference/cli' },
+ {
+ text: 'Default Theme',
+ items: [
+ {
+ text: 'Overview',
+ link: '/reference/default-theme-config'
+ },
+ {
+ text: 'Nav',
+ link: '/reference/default-theme-nav'
+ },
+ {
+ text: 'Sidebar',
+ link: '/reference/default-theme-sidebar'
+ },
+ {
+ text: 'Home Page',
+ link: '/reference/default-theme-home-page'
+ },
+ {
+ text: 'Footer',
+ link: '/reference/default-theme-footer'
+ },
+ {
+ text: 'Layout',
+ link: '/reference/default-theme-layout'
+ },
+ {
+ text: 'Badge',
+ link: '/reference/default-theme-badge'
+ },
+ {
+ text: 'Team Page',
+ link: '/reference/default-theme-team-page'
+ },
+ {
+ text: 'Prev / Next Links',
+ link: '/reference/default-theme-prev-next-links'
+ },
+ {
+ text: 'Edit Link',
+ link: '/reference/default-theme-edit-link'
+ },
+ {
+ text: 'Last Updated Timestamp',
+ link: '/reference/default-theme-last-updated'
+ },
+ {
+ text: 'Algolia Search',
+ link: '/reference/default-theme-search'
+ },
+ {
+ text: 'Carbon Ads',
+ link: '/reference/default-theme-carbon-ads'
+ }
+ ]
+ }
  ]
  }
  ]