markdown入门

Markdown是在开发人员和非开发人员中最受欢迎的文档格式之一。 编写和理解起来很容易，但是组织Markdown文档很困难。 在这篇文章中，我将向您介绍文档服务器 ，它使您可以以最少的精力管理项目的文档。

可以将Doctor视为内容管理系统（CMS），而不是传统的数据库后端，它使用Markdown文档作为后端。 只需在Doctor仪表板中添加文档的路径，然后Doctor即可在网络上提供这些文档。 您还可以使用Doctor将来自多个存储库的多个Markdown文件聚合到一个文档站点中。 因此，Doctor本质上将文档上下文与文档服务分离了-无论文档位于Google Drive，GitHub，Dropbox，ownCloud或其他地方，您都可以轻松地通过网站为它们提供服务。

根据Apache v2.0许可获得许可，Doctor由背后的团队创建。 Minio使用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之后，您可以通过浏览器访问主页。 只需在地址栏中输入 。 您应该会看到以下内容：

使用电子邮件和密码Doctor！23登录到仪表板。 首次登录时，仪表板如下所示：

基本

Doctor仪表板使您可以对文档进行分类，添加，分组，删除和发布。 首先，您需要一个可以在其中添加新文档的类别。 这样可以对文档进行逻辑分组。

要添加类别，请单击“ 类别”链接。 然后，单击右上角的“ 新建类别”按钮。 然后，您可以添加新类别的标题和描述：

添加类别后，添加新文档时它将自动显示。

下一步是添加一个新文档。 单击文档链接，然后单击右上角的新建文档按钮。 然后，您可以填写出现的表格。 这将添加一个新文档和相应的网页：

请注意，您应该输入指向原始Markdown文件的链接，否则该页面将无法正确显示。

出于演示目的，我将链接从Opensource.com 添加到 。 外观如下：

您可以在左侧的相应类别下看到页面的整齐排列。

客制化

要自定义Doctor页面，请单击“ 设置”链接。 在这里，您可以看到用于管理项目设置，社交链接和外观的选项。 通过“项目设置”部分，您可以编辑标题，徽标，家庭URL和描述。 您可以通过“社交链接”部分添加项目的社交媒体链接。 “外观”选项卡使您可以自定义配色方案，字体系列和字体大小。

Doctor还通过仪表板提供用户管理。 单击用户以添加或删除可以访问仪表板的用户。

结论

如果您需要管理以Markdown格式编写的文档，则很容易开始使用Doctor。 使用Doctor，您可以轻松地在Internet上管理和发布Markdown文档。

翻译自:

markdown入门