Welcome to MkDocs
For full documentation visit mkdocs.org.
Commands
mkdocs new [dir-name]
- Create a new project.mkdocs serve
- Start the live-reloading docs server.mkdocs build
- Build the documentation site.mkdocs help
- Print this help message.
Project layout
1 2 3 4 | mkdocs.yml # The configuration file. docs/ index.md # The documentation homepage. ... # Other markdown pages, images and other files. |
Admonition
https://squidfunk.github.io/mkdocs-material/extensions/admonition/
How to deploy mkdocs project to netlify
Add required package in requirements.txt
.
1 2 | # content in requirements.txt mkdocs==1.0.4 |
Specify python version in runtime.txt
.
1 2 | # content in runtime.txt 3.6 |
Create a new site and link git repository to netlify.
Specify the build command: mkdocs build
.
Specify the site folder: site
.
How to enable github page
Build your static site with local SSG like MkDocs
.
Add site folder to a git repository.
Go to settings in github for that repo and enable github page.
Done.