导航菜单

配置与主题

核心配置

  • title / description:站点基础信息。
  • base:部署子路径时设置,如 /docs/
  • lang:默认语言。
  • srcDir:内容目录(默认 .)。

导航与侧边栏

themeConfig: {
  nav: [{ text: '指南', link: '/guide/' }],
  sidebar: {
    '/guide/': [
      { text: '介绍', link: '/guide/' },
      { text: '安装', link: '/guide/install' },
    ],
  },
}

搜索

  • Algolia DocSearch:search: { provider: 'algolia', options: { appId, apiKey, indexName } }
  • 本地搜索:使用社区插件(如 vitepress-plugin-search)。

主题与自定义

  • 自定义布局:docs/.vitepress/theme/index.ts,可覆盖默认组件。
  • 添加全局样式:theme/style.css
  • 在 Markdown 中引入 Vue 组件:<Demo />,组件放 docs/.vitepress/theme/components/

其他常用项

  • lastUpdated:显示最后更新时间。
  • head:自定义 <head> 标签(如 meta/脚本)。
  • markdown:自定义 lineNumbersconfig(md) 扩展 Markdown。***

搜索