Welcome to my Mkdocs-template project

This is a MkDocs-template project.

Features

Out-of-box Features

theme: mkdocs-material with version 9.2.0b0
math support with MathJax3
markdown extension: example
fine-grained navigation control with awesome-pages

search: both English and Chinese

!!! warning

  Chinese language is supported by Japanese language. So unwanted effects may occur.

Advanced Features

Extra but simple configuration is required to enable advanced features.

Google Analytics

Other Features

Extensive configuration may occurs and these features are far from "out-of-box".

comment system by giscus

Quick start

Install

Create a virtual environment

Installing mkdocs-material from pip results in a legacy mkdocs-material version but this template adopts the latest mkdocs-material so locally installation is necessary and unavoidable mess your python environment. Thus a virtual python environment is HIGHLY recommended.

In 2023, please select a modern virtual env manager. Personally, I prefer miniconda.

Make sure that you have activated a virtual environment before continue the installation.

Clone repo

git clone --recursive https://github.com/GJCav/mkdocs-template.git

Install mkdocs-material

cd mkdocs-material
git checkout 9.2.0b0
pip3 install -e .

Install other requirements
```
pip3 install -r requirements.txt
```
Customize

Open file mkdocs.yml and modify it to suit your project.

Live preview

make serve

Build

make build

??? note "Why using make instead of mkdocs ?"

To support advanced features, extra configuration is necessary, I write a `Makefile` for it.

LICENSE

MIT License

Copyright (c) 2023 GJCav(https://github.com/GJCav)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

GJCav / mkdocs-template