简介

对于经常贡献并需要确切了解文档在合并后在 Web 界面中外观的贡献者来说，使用 Rocky Linux 文档的本地副本非常有帮助。此处包含的方法代表了截至目前的贡献者偏好。

对于那些认同“文档即代码”理念的人来说，使用文档的本地副本是开发过程中的一个步骤。“文档即代码”是一种类似于代码开发的文档工作流程。

Markdown 校验

除了用于存储和构建文档的环境之外，一些作者可能还会考虑使用 Markdown 校验器。Markdown 校验器在撰写文档的许多方面都很有帮助，包括检查语法、拼写、格式等。有时这些是独立的工具或编辑器插件。其中一个工具是 markdownlint，一个 Node.js 工具。markdownlint 是许多流行编辑器的插件，包括 Visual Studio Code 和 NVChad。因此，在文档目录的根目录下包含了一个 .markdownlint.yml 文件，该文件将应用于该项目可用的和启用的规则。markdownlint 是一个纯粹的格式校验器。它会检查多余的空格、内联 HTML 元素、双空行、不正确的制表符等。对于语法、拼写、包容性语言使用等方面，请安装其他工具。

免责声明

此类别（“本地文档”）中的任何项目都不是编写文档和提交批准所必需的。它们是为那些想要遵循“文档即代码”理念的人准备的，该理念至少包括文档的本地副本。文档即代码。

作者：Steven Spencer

贡献者：Ganna Zhyrnova