阅读文档:简化文档

乳臭虫

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

最新文档

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

每个版本的文档

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

开源和以用户为中心

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

第一次来这里?

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

阅读文档教程

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

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

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

示例项目

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

项目设置和配置

从设置项目的基础知识开始:

配置文件概述

了解如何使用.读取文档.yaml文件。

如何创建可复制的构建

了解如何使构建可复制。

生成过程

轻松构建文档:

构建过程概述

文档构建方式概述。

拉取请求预览

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

托管文档

进一步了解我们的托管功能:

版本

托管多个版本的文档。

子项目

在单个域下承载多个项目。

本地化和国际化

用多种语言保存文档。

URL版本控制方案

了解不同的版本控制方案。

自定义域

将文档托管在自己的域中。

维护项目

使您的文档保持最新:

重定向

将旧URL重定向到新URL。

搜索和流量分析

了解有关用户如何与您的文档交互的更多信息。

安全日志

跟踪项目中的安全事件。

业务特点

组织和企业的特点:

业务托管

进一步了解我们的商业功能。

组织

通过阅读文档了解如何管理您的组织。

单点登录(SSO)

通过阅读文档了解如何使用单点登录。

如何引导

常见任务的分步指南:

如何配置拉请求生成

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

如何使用流量分析

了解有关用户如何与您的文档交互的更多信息。

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

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

所有操作指南

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

参考

有关阅读文档的更多详细信息:

公共REST API

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

变更日志

查看阅读文档中的新增功能。

关于阅读文档

了解更多有关阅读文档和我们公司的信息。