Doc Tools
本插件集成了markdownlint、链接失效等多种常见文档问题的自动化检测修复功能,同时提供文档预览等功能,旨在提升文档开发体验。
安装
在 Visual Studio Code 中搜索插件并安装:
功能总览
静态检查
名称 | 功能 |
---|---|
Markdown Lint | Markdown 语法检查 |
Tag Closed Check | Html 标签闭合检查 |
Link Validity Check | 链接可访问性检查 |
Resource Existence Check | 资源有效性检查 |
Toc Check | 目录文件规范性检查 |
CodeSpell Check | 单词拼写检查 |
Filename Check | Markdown 文件命名规范检查 |
Punctuation Check | 标点符号检查 |
高级功能
名称 | 功能 |
---|---|
文档预览 | 预览 openEuler 文档风格的页面 |
目录生成 | 自动生成 _toc.yaml |
批量检查链接可访问性 | 批量检查选中目录下 Markdown 和 _toc.yaml 所有链接的可访问性 |
批量检查文件命名规范 | 批量检查选中目录下文件和子目录的命名规范性 |
批量检查中英文文档名称一致性 | 批量检查选中目录下 Markdown 中英文文档名称的一致性 |
生成链接锚点并复制 | 将选中标题生成链接锚点并复制 |
全局配置
插件支持以下配置项(可在 VSCode 设置中搜索 docTools.scope
或通过 settings.json
进行配置):
docTools.scope
- 类型:
boolean
- 说明:是否检查范围仅限于
docs/zh
和docs/en
目录 - 默认:
false
- 类型:
全局配置示例
json
{
"docTools.scope": false // 启用检查范围仅限于 docs/zh 和 docs/en 目录,默认检查项目全局文档
}
文档捉虫