简介

对于那些经常贡献并需要查看文档在合并后在 Web 界面中的确切外观的贡献者来说，使用 Rocky Linux 文档的本地副本非常有用。此处包含的方法代表了迄今为止贡献者的偏好。

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

Markdown 规范

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

免责声明

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

作者: Steven Spencer

贡献者: Ganna Zhyrnova