diff --git a/docs/zh/contribute/doc_tools.md b/docs/zh/contribute/doc_tools.md index 69798f7fc8869de3b769c7b754da7f9e12e20d52..b5c6f82e647102e7be6d4b6848683aad1b8fa9e9 100644 --- a/docs/zh/contribute/doc_tools.md +++ b/docs/zh/contribute/doc_tools.md @@ -13,11 +13,13 @@ | 名称 | 功能 | 执行时机 | 提示级别 | 提示语 | | -----| ----| ----------| -------- | -------| | [Markdown Lint](#markdown-lint) | Markdown 语法检查 | md 文件打开、保存、停止修改 1s 后 | warning | 具体的 markdownlint 规则 | -| [Tag Closed Check](#tag-closed-check) | Html 标签闭合检查 | md 文件打开、保存、停止修改 1s 后 | error | Unclosed html tag: ${tag} | -| [Link Validity Check](#link-validity-check) | 链接有效性检查(包含:1. 内链;2. 外链) | md 文件打开、 保存、停止修改 1s 后 | warning | Invalid link: ${link} | -| [Resource Existence Check](#resource-existence-check) | 资源是否存在检查(包含:1. 内链;2. 外链) | md 文件打开、保 存、停止修改 1s 后 | warning | Non-existent resource: ${resource} | -| [Toc Check](#toc-check) | 目录文件检查(1. 目录中引用的文件需要存在;2. 每一篇 md 文档都需要在目录中进行维护) | \_toc.yaml 打开、保 存、停止修改 1s 后,md 文件打开后会检测是否加入 \_toc.yaml | error | Non-existent doc in toc: ${doc} | -| CodeSpell Check | 单词拼写检查 | md 文件打开、保存、停止修改 1s 后 | info | CodeSpell warning: ${code} | +| [Tag Closed Check](#tag-closed-check) | Html 标签闭合检查 | md 文件打开、保存、停止修改 1s 后 | error | Unclosed html tag | +| [Link Validity Check](#link-validity-check) | 链接有效性检查(包含:1. 内链;2. 外链)| md 文件打开、 保存、停止修改 1s 后 | warning | Invalid link | +| [Resource Existence Check](#resource-existence-check) | 资源是否存在检查(包含:1. 内链;2. 外链)| md 文件打开、保 存、停止修改 1s 后 | warning | Non-existent resource| +| [Toc Check](#toc-check) | 目录文件检查(1. 目录中引用的文件需要存在;2. 每一篇 md 文档都需要在目录中进行维护) | \_toc.yaml 打开、保 存、停止修改 1s 后,md 文件打开后会检测是否加入 \_toc.yaml | error | Non-existent doc in toc | +| CodeSpell Check | 单词拼写检查 | md 文件打开、保存、停止修改 1s 后 | info | CodeSpell warning | +| [中英文标点混用检查](#中英文标点混用检查) | 中英文标点混用检查 | md 文件打开、保存、停止修改 1s 后 | warning | Mixing Punctuation | +| [中文标点冗余空格检查](#中文标点冗余空格检查) | 中文标点冗余空格检查 | md 文件打开、保存、停止修改 1s 后 | warning | Extra blank spaces | | [目录生成](#目录生成) | 自动生成`_toc.yaml` | 点击**生成目录**按钮 | 不涉及 | 不涉及 | | [文档预览](#文档预览) | 文档实时预览 | 点击**预览功能**按钮 | 不涉及 | 不涉及 | @@ -217,6 +219,39 @@ } ``` +## 中英文标点混用检查 + +![Punctuation Mix Check](public_sys_resources/biaodian_mix.gif) + +### 功能介绍 + +- 自动检测 Markdown 中英文混用标点的情况(例如:中文内使用英文标点,或英文内使用中文标点); +- 如需屏蔽此检测,可在该标点前后加空格(若后方紧跟其他标点符号,则无需额外空格)。 + - 例句1:添加 .png 后缀 + - 例句2:添加到 _toc.yaml。 + - 例句3:1. 这是一个有序列表 +- 支持通过配置项灵活启用或禁用该功能。 + +### 使用方法 + +1. 安装并启用本插件,打开 Markdown 文件(`.md`),自动检查文档中的中英文标点混用情况; +2. 检查结果会以警告(Warning)的形式在编辑器中高亮显示,可在“问题”面板,或将光标悬停在警告标记处,查看错误详情。 + +## 中文标点冗余空格检查 + +![Ch Punctuation Spacing Check](public_sys_resources/zhbiaodian_space.gif) + +### 功能介绍 + +- 自动检测 Markdown 文件中的中文标点符号前后存在空格的错误; +- 支持通过配置项灵活启用或禁用该功能。 + +### 使用方法 + +1. 安装并启用本插件,打开 Markdown 文件(`.md`),自动检查文档中的中文标点符号前后存在空格; +2. 检查结果会以警告(Warning)的形式在编辑器中高亮显示,可在“问题”面板,或将光标悬停在警告标记处,查看错误详情; +3. 可通过 VSCode 提供的 Quick Fix(快速修复)功能,点击灯泡图标或按下快捷键(通常为 `Cmd+.` 或 `Ctrl+.`),一键修复冗余空格问题。 + ## 目录生成 ![toc generation](public_sys_resources/toc_generation.gif) @@ -225,7 +260,7 @@ - 自动生成目录:根据实际存在的 Markdown 文件,自动生成`_toc.yaml`,避免手动维护目录结构; - 同步标题:自动读取每个 Markdown 文件的一级标题(# ),作为目录项的 label; -- 去除无效项:如果`_toc.yaml`中的某些 href 指向的文件不存在,会自动移除这些无效项; +- 去除无效项:如果`_toc.yaml`中的某些 href 指向的文件不存在,会自动移除这些无效项。 ### 使用方法 diff --git a/docs/zh/contribute/public_sys_resources/biaodian_mix.gif b/docs/zh/contribute/public_sys_resources/biaodian_mix.gif new file mode 100644 index 0000000000000000000000000000000000000000..f3f0793bea40b9da4f85e34ee8ed4ee533817ab3 Binary files /dev/null and b/docs/zh/contribute/public_sys_resources/biaodian_mix.gif differ diff --git a/docs/zh/contribute/public_sys_resources/zhbiaodian_space.gif b/docs/zh/contribute/public_sys_resources/zhbiaodian_space.gif new file mode 100644 index 0000000000000000000000000000000000000000..2cfb9d84e7e8a62751cd4d09176417ae4abed35c Binary files /dev/null and b/docs/zh/contribute/public_sys_resources/zhbiaodian_space.gif differ