My Wiki

This repo is generated from Material for MkDocs.

It adds three main features:

• TOC can highlight when locate a position.
• Preview h1 h2 h3 toc on the right sidebar.
• Preview all your wikis on the left sidebar.

Usage

1. Get the code

You can clone the repository right to where you want to host the wikis:

git clone https://github.com/chenggroup/chenggroup.github.io.git
cd chenggroup.github.io.git

2. Customize

To edit configuration values, customize the mkdocs.yml. To add wikis, write them into the wiki folder.

3. Options

Most of the configuration values in the mkdocs.yml are self explanatory, and for more details, see the documentation.

4. Serve

Depending on how you installed jekyll:

mkdocs serve

Look at getting started to get more information.