温馨提示×

温馨提示×

您好,登录后才能下订单哦!

密码登录×
登录注册×
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》

如何开源一个Python文档写作应用MrDoc

发布时间:2021-10-11 17:40:54 来源:亿速云 阅读:166 作者:柒染 栏目:大数据

如何开源一个Python文档写作应用MrDoc,相信很多没有经验的人对此束手无策,为此本文总结了问题出现的原因和解决方法,通过这篇文章希望你能解决这个问题。


一、为什么写MrDoc

从2016年底到今天,州的先生在博客上写了一百来篇文章,其中有不少的都是连载类型的系列教程。在积累了一定数量的文章之后,就打算将其整理为一个文集,方便读者朋友的连贯性阅读和学习。

但是博客使用的WordPress在进行文集管理方面并不是很好,于是就在市面上找各种文档文集系统。在这个过程中,接触到了如下几个优秀的文档写作系统。


GitBook

一个基于Node.js的文档写作工具,可使用 Github/Git 和 Markdown 来制作精美的电子书,其提供本地化地部署,也支持在gitbook上注册账号进行文档写作。

如何开源一个Python文档写作应用MrDoc

ShowDoc

一个国内团队开发的基于PHP的文档写作系统,可以快速使用Markdown编写文档,更加适用于技术团队的文档写作。

目前我在项目中即是使用其作为数据采集数据库的字段说明文档系统。同时也是提供了本地部署的开源版本和线上的使用版本。

如何开源一个Python文档写作应用MrDoc

WordBook

一个基于WordPress的文档写作主题,文档页面类似于gitbook。据说是免费的,但是下载主题需要加QQ群。

如何开源一个Python文档写作应用MrDoc

WeDocs

一个WordPress的插件和主题,目前州的先生博客的在线教程栏目既是使用这个插件编写的,离自己的需求还是差了那么一点。

如何开源一个Python文档写作应用MrDoc

每个系统都有各自的特点,功能也很丰富,但是在面对自己的需求的使用,也都有一些不如意的地方。兜兜转转还是觉得自己动手写一个比较好。仔细参考和借鉴了一下各个文档系统,发现基本功能的实现并不复杂,那就开干吧。


 

二、MrDoc都有哪些功能

MrDoc借鉴了上述部分应用的功能和样式,拥有以下特点:

  • 基于Django自带的用户模型,实现简单高效的用户管理,支持用户注册、用户登录、管理员等控制等功能;
  • 基于Editormd的Markdown编辑器,支持Markdown语法的文档写作,支持图片粘贴上传;
  • 提供文档模板功能,支持文档模板的创建、修改;
  • 仿GitBook文档阅读页面,支持文档阅读页面的字体缩放,字体类型修改;
  • 支持三级目录层级显示;

部分页面截图如下所示:

首页:

如何开源一个Python文档写作应用MrDoc

文档阅读页:

如何开源一个Python文档写作应用MrDoc


文档阅读页面切换字体、隐藏侧边栏:

如何开源一个Python文档写作应用MrDoc


文档编写页面:

如何开源一个Python文档写作应用MrDoc


选择文档模板:

如何开源一个Python文档写作应用MrDoc


 

看完上述内容,你们掌握如何开源一个Python文档写作应用MrDoc的方法了吗?如果还想学到更多技能或想了解更多相关内容,欢迎关注亿速云行业资讯频道,感谢各位的阅读!

向AI问一下细节

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

AI