init docs

README.md

@@ -0,0 +1,20 @@
+---
+title: README
+summary: Please read this file before you start editing anything.
+authors:
+    - Zhiyuan Chen
+date: 2020-05-03 01:27:32
+categories: 
+tags:
+    - README
+---
+
+Hello, and welcome to py-motmetrics documentation source!
+
+**Please do not merge this branch into any other branch other than documentation branch like this for any reason.**
+
+This documentation uses [MkDocs](https://www.mkdocs.org/) to compile the md documentations to static html web pages. You'll need Python installed on your computer to get started. Please run the following code in your favourite Python environment to install all the packages required.
+
+```python
+pip install -r requirements.txt
+```

docs/home.md

@@ -0,0 +1,11 @@
+---
+title: Home
+summary: Home
+authors:
+    - Zhiyuan Chen
+date: 2020-05-03 01:50:20
+categories: 
+tags:
+---
+
+We probably need some contents here! Meow~

mkdocs.yml

@@ -0,0 +1,63 @@
+site_name: py-motmetrics 
+site_url: https://py-motmetrics.github.io
+
+repo_name: py-motmetrics 
+repo_url: https://github.com/cheind/py-motmetrics
+
+nav:
+  - home:
+    - home: home.md
+
+theme:
+  name: material
+  language: 'en'
+  palette:
+    primary: 'Teal'
+    accent: 'Teal'
+  feature:
+    tabs: true
+  font:
+    text: 'Noto Sans'
+    code: 'Cascadia Code'
+
+extra:
+  manifest: 'manifest.webmanifest'
+
+extra_javascript: 
+    - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML
+
+markdown_extensions:
+  - admonition
+  - codehilite:
+      guess_lang: false
+      use_pygments: True
+      noclasses: True
+      pygments_style: monokai
+  - def_list
+  - footnotes
+  - mdx_math
+  - meta
+  - pymdownx.arithmatex
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.critic
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_generator: !!python/name:pymdownx.emoji.to_png
+  - pymdownx.inlinehilite
+  - pymdownx.keys
+  - pymdownx.magiclink
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.superfences
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+  - toc:
+      permalink: "#"
+
+plugins:
+  - search
+  - awesome-pages
+  # - git-committers

requirments.txt

@@ -0,0 +1,4 @@
+mkdocs
+mkdocs-material
+mkdocs-awesome-pages-plugin
+python-markdown-math