系统开发文档有哪些(开发文档是什么)

生活 0 647

MarkDown 编辑,快速书写;类 Gitbook,简洁阅读;后台管理。

州的先生(zmister.com)自用并完全开源、基于 Python 编写的文档写作系统。

MrDoc 拥有以下特点:

系统开发文档有哪些(开发文档是什么)

站点与用户系统简洁 基于Django自带的用户模型,实现简单高效的用户管理,支持用户注册、用户登录、管理员等控制等功能; 支持全站关闭注册; 支持注册邀请码配置; 支持广告位自定义配置; 支持统计代码自定义配置;

文档系统清晰 基于文集的文档撰写和阅读; 基于Editormd的Markdown编辑器,支持Markdown语法的文档写作,支持图片粘贴上传,支持从本地MD文件中插入内容; 提供文档模板功能,支持文档模板的创建、修改; 仿GitBook文档阅读页面,支持文档阅读页面的字体缩放,字体类型修改,页面社交分享,良好的移动端阅读体验; 支持三级目录层级显示; 支持文集后台导出为markdown文本格式.md文件、前台导出为EPUB电子书; 基于文集进行权限控制,提供公开、私密、指定用户可见、访问码可见4种权限模式;

二次开发方便 使用Django传统的MTV开发模式,路由、视图函数、模型易于理解; 使用非前端工程化构建前端页面,主要使用Layui进行页面布局和展示,方便改动;

在开发过程中,参考和借鉴了GitBook、ShowDoc、Wordbook等应用和网站的功能与样式。

网站架构

编程语言:Python 3

后端Web框架:Django 2

前端UI库:Layui 2.5.6

JS库:Jquery3.3

MarkDown编辑器:Editormd

页面社交分享:Share.js

Markdown科学公式:Katex.js

项目地址:https://gitee.com/zmister/MrDoc

相关推荐: