高级功能 ​

文档预览 ​

功能介绍 ​

• 支持文档实时预览功能，可完整呈现单本手册内容，可将 Markdown 语法渲染为格式化文本，同时能够解析_toc.yaml文件，生成目录导航；
• 支持保存后刷新预览页面；
• 支持从预览页面打开对应的 Markdown 文件或 _toc.yaml 文件。

使用方法 ​

1. 安装并启用本插件，打开 Markdown 文件；
2. 点击编辑器右上角的D字图标以打开预览页面；
3. 保存对 Markdown 文件的修改后，预览页面将自动刷新；
4. 修改关联的 _toc.yaml 文件后，预览页面将自动刷新。

目录生成 ​

功能介绍 ​

• 自动生成目录：根据实际存在的 Markdown 文件，自动生成 _toc.yaml，避免手动维护目录结构；
• 同步标题：自动读取每个 Markdown 文件的一级标题（# ），作为目录项的 label；
• 去除无效项：如果 _toc.yaml 中的某些 href 指向的文件不存在，会自动移除这些无效项。

使用方法 ​

1. 安装并启用本插件；
2. 右键点击目标目录，选择Doc Tools > 生成手册 _toc.yaml；
3. 按需调整 label 值和章节顺序。

注意事项 ​

• 只有带有一级标题（# 标题）的 Markdown 文件才会被收录。

批量检查链接可访问性 ​

功能介绍 ​

• 检测选中目录下的 Markdown 文档及 _toc.yaml 文件中的所有链接是否可访问；
• 以页面形式展示检测结果。

使用方法 ​

1. 安装并启用本插件；
2. 右键点击目标目录，选择Doc Tools > 检测链接可访问性；
3. 在打开的页面中按需勾选配置，点击开始检查；
4. 根据检查结果，修复失效链接或将误报链接加入白名单。

注意事项 ​

• 私有或受限网络下的链接可能因网络原因被误判为无效，请以实际访问为准。

批量检查文件命名规范 ​

功能介绍 ​

• 批量检查选中目录下所有文件和子目录的命名规范：使用小写英文字母并以下划线连接单词；
• 以页面形式展示检测结果，方便用户处理命名不规范的文件。

使用方法 ​

1. 安装并启用本插件；
2. 右键点击目标目录，选择Doc Tools > 检查目录、文件是否符合命名规范；
3. 在打开的页面中查看检查结果，根据提示信息修改不符合规范的文件名或目录名。

注意事项 ​

• 批量检查将遍历选中目录下的所有文件和子目录，可能需要一些处理时间；
• 修改文件名或目录名后，请同步更改其他文档中的相关链接。

检查中英文文档名称一致性 ​

功能介绍 ​

• 批量检查选中目录下中英文文档的文件名一致性；
• 通过页面展示检查结果，清晰标识缺少对应语言版本的文档。

使用方法 ​

1. 安装并启用本插件；
2. 右键点击目标目录，选择Doc Tools > 检查中英文文档名称一致性；
3. 在打开的页面中查看检查结果，根据提示信息补充缺失的文档，或修正不一致的文件名。

注意事项 ​

• 批量检查会遍历选中目录下的所有 Markdown 文件，可能需要一些处理时间；
• 修改文件名后请同步更改其他文档中的相关链接。

生成链接锚点并复制 ​

功能介绍 ​

• 将选中的文本生成锚点并复制到剪贴板，方便后续使用。

使用方法 ​

1. 安装并启用本插件；
2. 打开任意 Markdown 文件（.md）；
3. 选中标题文本；
4. 右击编辑区域，选择Doc Tools > 生成链接锚点并复制。

注意事项 ​

• 生成的锚点适用于 Vitepress 页面的锚点跳转；
• 通常情况下和大多数 Markdown 预览（如 VSCode 编辑器自带的 Markdown 预览）的锚点跳转一致，但在内容有一些符号的情况下存在一些差异，可能导致锚点在非 Vitepress 构建出的页面下不能跳转。