mkdocs-material-boilerplate
mkdocs-material-boilerplate copied to clipboard
MkDocs Material Boilerplate (Starter Kit) - Deploy documentation to hosting platforms (Netlify, GitHub Pages, GitLab Pages, and AWS Amplify Console) with Docker, pipenv, and GitHub Actions.
MkDocs Material
Boilerplate - Starter Kit
Details
Read more 👉 Documentation - MkDocs Material Boilerplate
Quick start
git clone https://github.com/peaceiris/mkdocs-material-boilerplate.git
cd mkdocs-material-boilerplate
pipenv sync --dev
pipenv shell
inv serve --config-file mkdocs-sample.yml
Links
- mkdocs/mkdocs: Project documentation with Markdown - GitHub
- squidfunk/mkdocs-material: A Material Design theme for MkDocs
License
- MIT License
- The graduate cap icon made by Freepik from www.flaticon.com is licensed by CC 3.0 BY