如何開源一個Python文檔寫作應用MrDoc

一、為什么寫MrDoc

從2016年底到今天，州的先生在博客上寫了一百來篇文章，其中有不少的都是連載類型的系列教程。在積累了一定數(shù)量的文章之后，就打算將其整理為一個文集，方便讀者朋友的連貫性閱讀和學習。

但是博客使用的WordPress在進行文集管理方面并不是很好，于是就在市面上找各種文檔文集系統(tǒng)。在這個過程中，接觸到了如下幾個優(yōu)秀的文檔寫作系統(tǒng)。

GitBook

一個基于Node.js的文檔寫作工具，可使用 Github/Git 和 Markdown 來制作精美的電子書，其提供本地化地部署，也支持在gitbook上注冊賬號進行文檔寫作。

ShowDoc

一個國內(nèi)團隊開發(fā)的基于PHP的文檔寫作系統(tǒng)，可以快速使用Markdown編寫文檔，更加適用于技術團隊的文檔寫作。

目前我在項目中即是使用其作為數(shù)據(jù)采集數(shù)據(jù)庫的字段說明文檔系統(tǒng)。同時也是提供了本地部署的開源版本和線上的使用版本。

WordBook

一個基于WordPress的文檔寫作主題，文檔頁面類似于gitbook。據(jù)說是免費的，但是下載主題需要加QQ群。

WeDocs

一個WordPress的插件和主題，目前州的先生博客的在線教程欄目既是使用這個插件編寫的，離自己的需求還是差了那么一點。

每個系統(tǒng)都有各自的特點，功能也很豐富，但是在面對自己的需求的使用，也都有一些不如意的地方。兜兜轉轉還是覺得自己動手寫一個比較好。仔細參考和借鑒了一下各個文檔系統(tǒng)，發(fā)現(xiàn)基本功能的實現(xiàn)并不復雜，那就開干吧。

二、MrDoc都有哪些功能

MrDoc借鑒了上述部分應用的功能和樣式，擁有以下特點：

• 基于Django自帶的用戶模型，實現(xiàn)簡單高效的用戶管理，支持用戶注冊、用戶登錄、管理員等控制等功能；
• 基于Editormd的Markdown編輯器，支持Markdown語法的文檔寫作，支持圖片粘貼上傳；
• 提供文檔模板功能，支持文檔模板的創(chuàng)建、修改；
• 仿GitBook文檔閱讀頁面，支持文檔閱讀頁面的字體縮放，字體類型修改；
• 支持三級目錄層級顯示；

部分頁面截圖如下所示：

首頁：

文檔閱讀頁：

文檔閱讀頁面切換字體、隱藏側邊欄：

文檔編寫頁面：

選擇文檔模板：