阅读文档：简化文档

乳臭虫

阅读文档简化了软件文档通过自动构建、版本控制和托管文档。像对待代码一样对待文档可以让您的团队使用相同的工具，以及最新的文档。

🔄 最新文档

每当您将代码推送到Git时，阅读文档将自动生成您的文档所以您的代码和文档总是最新的。开始使用我们的辅导的.

🗂️ 每个版本的文档

阅读文档可以承载多个版本的文档。保持1.0和2.0文档在线，直接从Git中提取。开始托管您的所有版本.

💓 开源和以用户为中心

我们的公司是自我引导的，100%以用户为中心，因此，我们的产品对我们的用户而不是投资者来说更好。阅读超过100000个大型社区主机的文档和小型开源项目。阅读Docs for Business支持数百个组织的产品和内部文档。了解有关的更多信息我们的两个平台.

第一次来这里？

我们有几个地方让您开始：

🚀阅读文档教程

通过阅读文档，迈出第一步。

🚀示例项目

以一个成功的项目开始你的旅程。

🚀所有教程

首次使用Sphinx或MkDocs等文档工具还是导入现有项目？我们有教程可以帮助您开始！

解释

从较高层次概述我们的平台：

💡连续文档

了解持续部署文档的优点。

💡在我们的两个平台之间进行选择

了解阅读文档社区和阅读业务文档之间的区别。

操作指南

需要做一些具体的事情吗？这些指南提供了有关各个领域的逐步说明：

🪄如何配置拉请求生成

设置拉请求生成并享受每次提交的预览。

🪄如何使用流量分析

进一步了解用户如何与文档交互。

🪄如何使用狮身人面像的交互参考

了解如何在狮身人面像项目中使用交叉引用。

🪄所有操作指南

浏览整个目录以获得更多操作指南。

参考

需要知道某些东西是如何工作的？我们的参考资料提供了详细信息：

📚功能参考

阅读文档的所有主要功能概述。

📚配置文件

配置文件信息：.读取文档.yaml.

📚构建过程概述

文档构建方式概述。

📚生成流程自定义

有关如何添加自己的构建逻辑或替换默认构建步骤的信息。

📚公共API

使用我们的API自动化您的文档并为您节省一些工作。