目录页面

VuePress Theme Hope 默认使用 vuepress-plugin-catalog 为每个文件夹自动生成带有目录的 README.md。

介绍

你可以在主题选项中使用 plugin.autoCatalog 来控制此功能。 如果要禁用它，请将 plugin.autoCatalog 设置为 false。

你可以使用 plugin.autoCatalog.exclude 从目录生成中排除一些文件夹，也可以使用 plugin.autoCatalog.frontmatter 来控制 frontmatter 的生成。

有关详细信息，请参阅 Auto Catalog 插件文档。

示例

主页目录:

目录

V2 迁移指南

• V2 亮点
• 样式迁移指南
• 配置迁移指南
• 页面迁移指南

变更日志

基础教程

• 小白教程
  准备运行环境创建项目项目命令项目内容配置项目项目结构部署项目
• Markdown 介绍
  Emoji 列表Markdown 示例
• VuePress
  VuePress 页面内置 Markdown 拓展文件结构介绍VuePress 配置插件主题配置
• 自定义
  使用组件修改字体修改布局修改特效修改颜色

常见问题

• Safari 常见问题
• Vite 常见问题
• 常见错误
• 故障排查

指南

• 快速上手
  主题介绍安装/使用Markdown
• 界面
  纯净模式无障碍深色模式主题色图标支持代码主题响应式布局样式定制其他界面功能
• Markdown 增强
  代码块分组其他外部引入ChartEChartsMermaidTex 语法Vue 交互演示上下角标交互演示代码演示任务列表卡片图片导入文件属性支持幻灯片标记样式化流程图组件脚注自定义容器自定义对齐启用 Markdown 增强选项卡
• 布局
  导航栏侧边栏页脚支持页面目录页面路径导航首页幻灯片
• 功能
  代码复制加密图片预览搜索版权信息页面信息页面元数据评论
• 博客
  博客功能介绍博主信息文章列表分类与标签时间线博客首页博客页面路径
• 高级
  替换主题组件Feed 支持PWASEOSitemap主题预设主题继承

案例

• 功能项目主页
• 加密文章 (密码: 1234)
• 博客主页
• 插槽演示
• 真实项目
• 自定义博客主页

贡献指南

配置

• 配置介绍
• 多语言
• 主题配置
  主题基本选项主题功能选项主题布局选项主题外观选项主题多语言选项主题行为选项
• 插件配置
  插件说明博客配置评论插件配置版权信息插件配置Feed 插件配置MdEnhance 插件配置PWA 插件配置其他插件选项
• Frontmatter 配置
  信息 Frontmatter 配置布局 Frontmatter 配置插件 Frontmatter 配置主页 Frontmatter 配置博客主页 Frontmatter 配置
• 样式配置

<AutoCatalog base='/zh/' />