Markdown 是开发人员和非开发人员中最流行的文档格式之一。它易于编写和理解，但组织 Markdown 文档很困难。在这篇文章中，我将向您介绍 Doctor，一个文档服务器，可让您以最少的精力管理项目的文档。
可以将 Doctor 视为内容管理系统 (CMS)，但它没有传统的数据库后端，而是使用您的 Markdown 文档作为后端。只需在 Doctor 仪表板中添加文档的路径，Doctor 就会在 Web 上提供这些文档。您还可以使用 Doctor 将来自多个存储库的多个 Markdown 文件聚合到一个文档站点中。因此，Doctor 本质上将文档上下文与文档服务分离——无论您的文档位于何处，在 Google Drive、GitHub、Dropbox、ownCloud 或其他位置，您都可以通过网站轻松地提供它们。
Doctor 采用 Apache v2.0 许可证，由 Minio，一个对象存储服务器 背后的团队创建。Minio 使用 Doctor 来托管他们的文档。查看这个 Doctor 演示。
安装
您可以选择传统方式安装 Doctor，即安装框架和数据库，然后运行 Doctor，或者您可以使用 Docker 快速启动 Doctor 实例并查看其运行情况。我将在此处讨论这两个步骤，首先从传统方法开始。
要在您的系统上安装 Doctor，您需要安装以下组件
- Ruby 2.2.2 和 Rails 4.2.4
- PostgreSQL
安装完成后，运行以下命令来安装和运行 Doctor
$ git clone https://github.com/minio/doctor.git
$ cd doctor
$ bundle install
$ rake db:drop
$ rake db:setup
$ rails s如果您希望 Docker 容器运行您的 Doctor 实例，请运行以下命令。请注意，在执行此操作之前，您需要在系统上安装 Docker
$ git clone https://github.com/minio/doctor.git
$ cd doctor
$ docker-compose up成功安装 Doctor 后，您可以通过浏览器访问主页。只需在地址栏中键入 http://localhost:3000。您应该看到类似这样的内容
使用电子邮件sysadmin@doctor.io 和密码 Doctor!23 登录到仪表板。首次登录时，仪表板如下所示
基础知识
Doctor 仪表板允许您对文档进行分类、添加、分组、删除和发布。首先，您需要一个类别，您可以在其中添加新文档。这为文档提供了逻辑分组。
要添加类别，请单击类别链接。然后单击右上角的新类别按钮。然后，您可以添加新类别的标题和描述
添加类别后，当您添加新文档时，它会自动显示。
下一步是添加新文档。单击文档链接，然后单击右上角的新文档按钮。然后，您可以填写出现的表格。这将添加一个新文档和一个相应的网页
请注意，您应该输入原始 Markdown 文件的链接，否则页面将无法正确呈现。
出于演示目的，我添加了来自 Opensource.com GitHub 个人资料的 《开放组织实地指南》 的链接。这是它的外观
您可以看到页面如何在左侧相应类别下整齐排列。
自定义
要自定义 Doctor 页面，请单击设置链接。在这里，您可以看到管理项目设置、社交链接和外观的选项。项目设置部分允许您编辑标题、徽标、主页 URL 和描述。您可以通过社交链接部分添加项目的社交媒体链接。“外观”选项卡允许您自定义配色方案、字体系列和字体大小。
Doctor 还通过仪表板提供用户管理。单击用户以添加或删除可以访问仪表板的用户。
结论
如果您需要管理以 Markdown 格式编写的文档，那么 Doctor 非常容易上手。使用 Doctor，您可以以最少的精力在 Internet 上管理和发布您的 Markdown 文档。
2 条评论