Shulou(Shulou.com)06/02 Report--

How to open source a Python document writing application MrDoc, I believe many inexperienced people are helpless about this, for this reason this article summarizes the causes and solutions of the problem, through this article I hope you can solve this problem.

Why write MrDoc?

From the end of 2016 to today, Mr. Zhou has written more than 100 articles on his blog, many of which are serial tutorials. After accumulating a certain number of articles, I intend to organize them into a collection to facilitate the readers 'coherent reading and learning.

But WordPress, which blogs use, is not very good at corpus management, so I look for various document corpus systems on the market. In this process, I came across several excellent document writing systems as follows.

GitBook

A Node. js-based document writing tool that uses Github/Git and Markdown to create beautiful eBooks, which provides localized deployment, and also supports registering accounts on gitbook for document writing.

ShowDoc

A domestic team development based on PHP document writing system, you can quickly use Markdown to write documents, more suitable for technical team document writing.

I am currently using it as a field description documentation system for data acquisition databases in my projects. It also provides both an open source version for local deployment and an online version for use.

WordBook

A WordPress-based document writing theme, document pages similar to gitbook. It is said to be free, but download the theme needs to add QQ group.

WeDocs

A WordPress plug-in and theme, Mr. State blog online tutorial column is written using this plug-in, from their own needs or a little bit worse.

Each system has its own characteristics, functions are also very rich, but in the face of their own needs, there are also some unsatisfactory places. I thought it would be better to write one myself. Careful reference and reference to the various documentation systems, found that the implementation of basic functions is not complex, then open it.

2. What are the functions of MrDoc

MrDoc draws on the functions and styles of the above applications and has the following characteristics:

Based on Django's own user model, simple and efficient user management, support user registration, user login, administrator control and other functions; Editormd based Markdown editor, support Markdown syntax document writing, support image paste upload; Provide document template function, support document template creation and modification; Imitate GitBook document reading page, support document reading page font zoom, font type modification; Support three-level directory hierarchy display;

Some screenshots of the page are shown below:

Home Page:

Document reading page:

Document Reading Page Toggle font, hide sidebar:

Documentation page:

Select a document template:

After reading the above, do you know how to open source a Python document writing application MrDoc? If you still want to learn more skills or want to know more related content, welcome to pay attention to the industry information channel, thank you for reading!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.