This blog is written in markdown and uses mkdocs to generate the HTML hosted using Git Pages on github
Workflow
- Create new content
- Push content
git add .
git commit -a -m "new stuff"
git push
- Push to Git Pages
mkdocs gh-deploy
Reference
This wiki use mkdocs and the mkdocs-material theme
MkDocs is a static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
Reference: http://bwmarrin.github.io/MkDocsPlus/fontawesome/
Note: This has been tested with python 3.6 running on MacOS.
Requirements
pip3.6 install mkdocs
pip3.6 install mkdocs-material
pip3.6 install pygments
pip3.6 install pymdown-extensions
pip3.6 install fontawesome-markdown
- Material Theme Documentation and Reference: http://mkdocs.github.io/mkdocs-bootswatch/#installation-usage
- https://squidfunk.github.io/mkdocs-material/getting-started/
- https://facelessuser.github.io/pymdown-extensions/
./docs/: mkdocs content./docs/img/: Store all course images heremkdocs.yml: mkdocs configuration file./site/: Prod version of site. Not tracked in git. Used for testing or manual deployment
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent