- Click on the green button
Use this template
- Edit all the
PLACEHOLDER
inmkdocs.yml
with respect tosite_name
,repo_name
andrepo_url
. - Edit all the
PLACEHOLDER
indocs/index.md
,docs/reference.md
anddocs/instructor.md
. - Add appropriate content to
docs/index.md
,docs/reference.md
anddocs/instructor.md
.
We use Material for MkDocs (MIT License) as the static site generator.
- Clone the repository
- Install Material for MkDocs with
pip install mkdocs-material
- Create or review content
- Preview the site with
mkdocs serve
- Make a Pull Request
This template is already configured for MathJax to work, both using inline and block syntax.
- Author 1 - email@example.com
- Author 2 - email@example.com
- Author 3 - email@example.com
This content is licensed under Creative Commons Attribution-ShareAlike 4.0 International.