cool hit counter Software project documentation wizard MKDocs_Intefrankly

Software project documentation wizard MKDocs


Most programmers love to write code, but not documentation. Here is a recommended software project documentation wizard, MKDocs. You can happily, again, write documents using Markdown.

Installation Process

Install python

Installing pip

Installing mkdocs using pip

Install python

The installation of python is relatively simple, and it's built right in for Mac systems. For other systems, you can download the official python installer directly from python and just follow the instructions step by step.

python official website:https://www.python.org/downloads/

After installing python, we can enable the terminal to see the system python version

Installing pip

You can download the pip installation file from the terminal using wget

wget https://bootstrap.pypa.io/get-pip.py

Then execute.

python get-pip.py

After successful installation of pip, you can check the version of pip

pip --version

Installing mkdocs

Installing mkdocs using pip

pip install mkdocs

After successful installation, you can view the mkdocs version

Create a document project

Create documentation project for laramall mall system laramall-doc

mkdocs new laramall-doc

Switch to laramall-doc

cd laramall-doc

Start a documentation project

mkdocs serve

Visit the project website

http://127.0.0.1:8000

Screenshots of the project are as follows.

Official website and theme URL

mkdocs official website

material theme website

https://squidFunk.github.io/mkdocs-material/

Advantages of mkdocs

Markdown based writing, very quick and easy

Can generate pure static html files

Beautiful theme and easy theme development

Fast On-line Easy Deployment

Based on python

Easy to configure using yaml files

If you like it, feel free to go and use it :)


Recommended>>
1、How to get network access to iOS apps
2、Design Patterns of Singleton Pattern ExplainedDesign Patterns of Singleton Pattern Explained
3、Double the performance of UFS21 UFS30 officially released 29GBs
4、A smart ring with builtin AI technology to help you with all kinds of sleep problems
5、Tencent Cloud Releases Data Security Solution Digital Shield to Address Three New Pain Points

    已推荐到看一看 和朋友分享想法
    最多200字,当前共 发送

    已发送

    朋友将在看一看看到

    确定
    分享你的想法...
    取消

    分享想法到看一看

    确定
    最多200字,当前共

    发送中

    网络异常,请稍后重试

    微信扫一扫
    关注该公众号