MkDocs is a static site generator that builds modern webpages based on your Markdown documents and a simple YAML file.
$ pip install mkdocs
site_name: Awesome Python site_url: https://awesome-python.com site_description: A curated list of awesome Python frameworks, libraries and software site_author: Vinta Chen repo_url: https://github.com/vinta/awesome-python theme: flatly google_analytics: ['UA-510626-7', 'auto'] pages: - "Life is short, you need Python.": "index.md"
There are more themes:
site_install: pip install mkdocs==0.16.3 pip install mkdocs-material==1.12.2 site_link: ln -sf $(CURDIR)/README.md $(CURDIR)/docs/index.md site_preview: site_link mkdocs serve site_deploy: site_link mkdocs gh-deploy --clean
Custom Domain for GitHub Pages
After deploying your GitHub Page, just pointing your domain to
126.96.36.199 with an A DNS record.