python写作_开源一个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

期待你的建议，让MrDoc更加完善：)

python写作_开源一个Python文档写作应用：MrDoc相关推荐

python api文档管理工具_开源的api文档管理系统
在项目中,需要协同开发,所以会写许多API文档给其他同事,以前都是写一个简单的TXT文本或Word文档,口口相传,这种方式比较老土了,所以,需要有个api管理系统专门来管理这些api,从网上找了许多比 ...
anaconda怎么运行python程序_第一个python程序，从安装python环境到人生第一个py脚本运行全过程...
文章目录前言一.安装python运行环境 1.官网https://www.python.org下载安装包.exe 2.安装python二.python模块下载 1.配置pip环境变量 2.下载pyt ...
第一个python解释器_第一个python程序
回顾昨日重点(需记住5*) 三大核心: cpu--运行程序内存--基于电,存取速度快,断电丢失数据硬盘--基于磁,存取速度远远慢于内存,断电不丢失数据操作系统应用程序操作系统 (window ...
python打分_做一个Python颜值打分系统，比比看杨幂和杨超越到底谁更美？
下面就来讲讲我设计的这套颜值打分系统,先上图片让大家看一下效果,比如看一下我的女神杨幂的颜值如何: 怎么样,结果是相当的精准吧,大家是不是已经跃跃欲试了呢?下面就针对该颜值打分系统进行讲解. 01. ...
如何用python创建文件_怎么用python建立一个txt文档，并输入内容-百度经验
这里,我要用python,在电脑桌面上,新建一个文件夹a,并在文件夹a里面,建立一个txt文档--b.txt,写上如下文字: 你好, 世界. 工具/原料电脑 python 方法/步骤 1 在电脑桌面 ...
python word排版_使用Python通过win32 COM实现Word文档的写入与保存方法
通过win32 COM接口实现软件的操作本质上来看跟直接操作软件一致,这跟我之前经常用的通过各种扩展的组件或者库实现各种文件的处理有较大的差异.如果有过Windows下使用Word的经历,那么使用wi ...
用python来构建一个word文档-写文章
直接使用word文档已经难不倒大家了,有没有想过用python构建一个word文档写点文章呢?当然这个文章的框架需要我们用代码一点点的建立,在过程上有一点繁琐,一下子看不懂的小伙伴可以把它拆分成几个部 ...
python翻译器怎么用_给宝宝用Python写个支持翻译PDF文档的小软件
上次用Python写好翻译doc文档小软件后就展示给宝宝,我:"宝宝,过来给你个小软件" 她:"干什么用哒?" 我:"给你翻译Word文档的" ...
python读取图片文字为表格_利用python将图片转换成excel文档格式
前言本文主要介绍了关于利用python将图片转换成excel文档的相关内容,分享出来供大家参考学习,下面话不多说了,来一起看看详细的介绍吧. 实现步骤读取图像,获取图像每个像素点的RGB值: 根据 ...
python将excel转换成图片格式_利用python将图片转换成excel文档格式
前言本文主要介绍了关于利用python将图片转换成excel文档的相关内容,分享出来供大家参考学习,下面话不多说了,来一起看看详细的介绍吧. 实现步骤读取图像,获取图像每个像素点的RGB值: 根据 ...

python写作_开源一个Python文档写作应用：MrDoc

python写作_开源一个Python文档写作应用：MrDoc相关推荐

最新文章

热门文章