Documentation Template

This repository works as template for developing documentation for our open source project.

How to use

• click button use this template

• create new repository based on this repository, check include all branches

• Install python and pip

• Install mkdocs-material using pip by running this command:

  pip install mkdocs-material
  

• Run this line to preview demo

  python -m mkdocs serve
  

You then can start documenting your project using markdown format, without any knowledge of HTML, Javascript, or CSS.

Demo

You can see the demo here

Configuration

More configuration can see here