开源一个Python文档写作系统:MrDoc

一、为什么写MrDoc

从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演示站点。

五、反馈建议和Bug

如果你在使用过程中有好的建议或遇到了Bug,欢迎给州的先生反馈。

1、提交issue

直接在https://gitee.com/zmister/MrDoc/issues 页面提交问题。

2、加入MrDoc 交流QQ群

加入MrDoc交流QQ群,群号为735507293,入群密码:mrdoc

猜你也喜欢

发表评论

电子邮件地址不会被公开。