从2016年底到本日,州的师长西席在博客上写了一百来篇文章,个中有不少的都是连载类型的系列教程。在积累了一定数量的文章之后,就打算将其整理为一个文集,方便读者朋友的连贯性阅读和学习。但是博客利用的WordPress在进行文集管理方面并不是很好,于是就在市情上找各种文档文集系统。在这个过程中,打仗到了如下几个精良的文档写作系统:
Gitbook
一个基于Node.js的文档写尴尬刁难象,可利用 Github/Git 和 Markdown 来制作精美的电子书,其供应本地化地支配,也支持在gitbook上注册账号进行文档写作。

ShowDoc
一个海内团队开拓的基于PHP的文档写作系统,可以快速利用Markdown编写文档,更加适用于技能团队的文档写作。目前我在项目中既是利用其作为数据采集数据库的字段解释文档系统。同时也是供应了本地支配的开源版本和线上的利用版本。
WordBook
一个基于WordPress的文档写作主题,文档页面类似于gitbook。听说是免费的,但是下载主题须要加QQ群。
WeDocs
一个WordPress的插件和主题,目前州的师长西席博客的在线教程栏目既是利用这个插件编写的,离自己的需求还是差了那么一点。
每个别系都有各自的特点,功能也很丰富,但是在面对自己的需求的利用,也都有一些不快意的地方。兜兜转转还是以为自己动手写一个比较好。仔细参考和借鉴了一下各个文档系统,创造基本功能的实现并不繁芜,那就开干吧。
二、MrDoc都有哪些功能
MrDoc借鉴了上述部分运用的功能和样式,拥有以下特点:
基于Django自带的用户模型,实现大略高效的用户管理,支持用户注册、用户登录、管理员等掌握等功能;基于Editormd的Markdown编辑器,支持Markdown语法的文档写作,支持图片粘贴上传;供应文档模板功能,支持文档模板的创建、修正;仿GitBook文档阅读页面,支持文档阅读页面的字体缩放,字体类型修正;支持三级目录层级显示;部分页面截图如下所示:
首页:
文档阅读页:
文档阅读页面切换字体、隐蔽侧边栏:
文档编写页面:
选择文档模板:
三、如何下载MrDoc
目前,MrDoc已经将代码托管到开源中国旗下的代码托管平台——Gitee上,项目地址为:https://gitee.com/zmister/MrDoc
如须要的小伙伴可以前往下载。
四、如何利用MrDoc
有关于MrDoc的利用和二次开拓,州的师长西席已经在编写《MrDoc解释文档》,网址为:http://mrdoc.zmister.com
此网站亦是基于MrDoc搭建的MrDoc演示站点。
原文作者:州的师长西席原文地址:https://zmister.com/archives/1057.html