目录页面

VuePress Theme Hope 通过 vuepress-plugin-catalog 提供目录组件和目录页自动生成。

自动目录页生成

该功能是默认启用的，如果文件夹下没有 README.md，主题会为自动为它生成一个目录页。如需禁用，请将 plugin.autoCatalog 设置为 false。

你可以在主题选项中通过 plugin.autoCatalog 来控制它，比如:

• 通过 plugin.autoCatalog.exclude 从目录生成中排除一些文件夹
• 通过 plugin.autoCatalog.frontmatter 来控制 frontmatter 的生成。

有关详细配置，请参阅 Auto Catalog 插件文档。

目录组件

你可以直接在 Markdown 中使用 <AutoCatalog> 组件来显示目录。

主页目录案例

目录

• V2 迁移指南

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

• 指南

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

• 快速上手

  • 运行环境设置
  • 创建项目
  • 项目命令
  • 项目内容
  • 配置项目
  • 项目结构
  • 部署项目

• 常见问题

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

• 案例

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

• 基础教程

  • VuePress
    VuePress 页面内置 Markdown 拓展文件结构介绍VuePress 配置插件主题配置
  • Markdown 介绍
    Emoji 列表Markdown 示例

• 配置

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

• 变更日志

• 相关插件

• 贡献指南

<!-- 用于限制高度 -->
<div class="catalog-display-container">
  <AutoCatalog base='/zh/' />
</div>