帮助改进此页面
要帮助改进本用户指南,请选择位于每个页面右侧窗格中的在 GitHub 上编辑此页面链接。
您可以在键入时查看样式反馈。这有助于识别写作错误和错别字。

概述:
-
Vale CLI 会加载并针对源文件运行样式指南。
-
EKS Docs 存储库包含一个用于加载样式指南和本地规则的 vale 配置文件。
-
适用于 Visual Studio(VS)Code 的 Vale 扩展会在编辑器中显示 vale 反馈。
安装 Vale
按照 Vale CLI 文档中的说明使用 Package Manager 安装 Vale
安装 VS Code Vale 扩展
-
打开 VS Code。
-
单击活动栏中的扩展程序图标(或按 Ctrl+Shift+X)。
-
搜索“Vale”。
-
在 Chris Chinchilla 的“Vale VSCode”扩展程序上单击“安装”。
-
出现提示时重新加载 VS 代码。
同步 Vale
Vale 会使用项目根目录中的 .vale.ini
配置文件来确定要应用哪些样式规则。
-
打开 VS Code。
-
单击查看 > 终端(或按 Ctrl+`)。
-
如果需要,导航到项目的根目录。
-
运行命令:
vale sync
-
等待 Vale 完成样式规则的下载和同步
在 VS Code 中查看样式反馈
-
在 VS Code 中打开一个 Markdown 或 AsciiDoc 文件。
-
Vale 扩展程序会根据样式规则自动检查文本。
-
样式问题将在编辑器中用下划线表示。
-
将鼠标悬停在带下划线的文本上可查看具体的样式建议。
-
根据建议或样式指南修复问题。