基於 Python 開發的在線文檔系統

MarkDown 編輯,快速書寫;類 Gitbook,簡潔閱讀;後臺管理。

基於 Python 開發的在線文檔系統

州的先生(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


分享到:


相關文章: