Overview
I released MkDocs Material Boilerplate - Starter Kit 🚀
👉 peaceiris/mkdocs-material-boilerplate - GitHub
MkDocs Material Boilerplate (Starter Kit) - Deploy documentation to platforms (Netlify, GitHub Pages, GitLab Pages, and AWS Amplify Console) with Docker, pipenv, and GitHub Actions.
Issues, pull requests, comments, and GitHub star ⭐️ are welcome❗️
What is MkDocs
MkDocs is one of the best static site generators. We can write our document using markdown and MkDocs builds static site from markdown.
MkDocs Material is one of the MkDocs theme based on Material Design.
Deploy to platforms
We have a lot of choices to manage documentation and deploy it.
-
GitHub Pages + GitHub +
-
mkdocs gh-deploycommand - CircleCI
- GitHub Actions
-
- GitLab Pages + GitLab + GitLab CI/CD
-
Netlify +
- GitHub
- GitLab
- BitBucket
-
AWS Amplify Console +
- GitHub
- GitLab
- BitBucket
- AWS CodeCommit
This boilerplate includes build and deploy settings. We can easily publish our documentation right now❗️
👉 Demo site on GitHub Pages (build & deploy with GitHub Actions)
More
Go to peaceiris/mkdocs-material-boilerplate - GitHub to get more information.
Thanks for reading and enjoy MkDocs❗️
peaceiris
/
mkdocs-material-boilerplate
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
Top comments (0)