Doctor：开源文档服务器

于 2016 年 8 月 5 日

Doctor : An Open Source Documentation Server

Doctor 使用 **Markdown (MD) 格式** 进行文档编写，并使用 **GitHub 进行版本控制**。Doctor 用于将多个来自不同仓库的 MD 文件聚合到一个单独的文档网站中。Doctor 采用 Apache V2.0 许可证授权。

查看实时演示：https://docs.minio.io

为什么我们构建 Doctor

我们想要一个文档服务器来简单地组织和渲染来自 GitHub 的 Markdown 页面。我们喜欢 Markdown，因为它易于我们的非开发人员创建/编辑文档。我们需要让社区参与到改进文档的过程中。最后，我们需要一个看起来不像 GitHub 源代码库的文档网站。在评估了各种框架、CMS 解决方案、云托管平台和基于 TeX/DocBook 的工具后，我们最终构建了 Doctor。

部署 Doctor

Doctor 可以轻松部署到 Heroku 上进行生产环境，也可以在本地进行开发环境部署。

本地部署

安装 Ruby 2.2.2。
安装 Rails 4.2.4
安装 PostgreSQL 并启动 PostgreSQL。
在终端中输入以下命令

> git clone https://github.com/minio/doctor.git
> cd doctor
> bundle install
> rake db:drop
> rake db:setup
> rails s

访问 http://localhost:3000

Heroku 部署

创建一个新的 Heroku 应用
对 https://github.com/minio/doctor 仓库进行 fork
使用 Heroku 中的“Deploy”选项卡，将 GitHub fork 连接到您的 Heroku 应用
点击“Deploy branch”来成功构建和部署 Doctor 以满足您的需求。
在终端中输入以下命令

> heroku run rake db:drop
> heroku run rake db:setup

在浏览器中访问 Heroku 应用。

管理文档

创建类别。
创建文档。
在创建文档时，粘贴来自 GitHub 的 MD 文件的完整原始链接。

将每个文档与特定类别关联。保存即可完成。

社区协作

协作是我们另一个关键需求。在让社区为我们的项目做出贡献方面，我们采取了非同寻常的立场。因此，我们在 Doctor 中提供了“建议编辑”功能，任何使用我们文档的开发人员都可以通过点击“建议编辑”按钮，并向我们发送一个包含他们修改的简单 PR 来建议修改。然后使用 GitHub 工作流程来管理提交的文档修改。这是我们在云托管文档解决方案、内容管理系统或框架中无法找到的功能。

自定义

用户可以在仪表板中编辑项目详细信息，并更改项目名称，配置标题和页脚中的链接。请参阅以下截图。

品牌自定义

还提供完整的样式指南，可在此处查看：这里。

结论

Doctor 旨在保持简洁。请随时 fork 此项目。如果您开发了任何酷炫的功能，请考虑与我们的社区分享。我们很乐意看到您的 Pull Request。

在以下地址为 Doctor 贡献：https://github.com/minio/doctor

可在以下地址找到 Doctor 的增强功能和问题列表：https://github.com/minio/doctor/issues