https://github.com/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.
https://github.com/peaceiris/mkdocs-material-boilerplate

aws boilerplate docker dockerfile github-pages gitlab-pages mkdocs mkdocs-material netlify starter-kit static-site-generator

Last synced: about 1 month ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/peaceiris/mkdocs-material-boilerplate
• Owner: peaceiris
• License: mit
• Created: 2019-01-26T07:16:07.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2024-09-29T18:09:40.000Z (about 1 month ago)
• Last Synced: 2024-10-01T10:01:46.927Z (about 1 month ago)
• Topics: aws, boilerplate, docker, dockerfile, github-pages, gitlab-pages, mkdocs, mkdocs-material, netlify, starter-kit, static-site-generator
• Language: Python
• Homepage: https://mkdocs.peaceiris.com/
• Size: 8.28 MB
• Stars: 124
• Watchers: 5
• Forks: 55
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        





MkDocs Material
Boilerplate - Starter Kit



![Eyecatch image of MkDocs Material Boilerplate (Starter Kit)](https://raw.githubusercontent.com/peaceiris/mkdocs-material-boilerplate/main/docs_sample/images/material.png)

[![license](https://img.shields.io/github/license/peaceiris/mkdocs-material-boilerplate.svg)](https://github.com/peaceiris/mkdocs-material-boilerplate/blob/main/LICENSE)

[![release](https://img.shields.io/github/release/peaceiris/mkdocs-material-boilerplate.svg)](https://github.com/peaceiris/mkdocs-material-boilerplate/releases/latest)

[![GitHub release date](https://img.shields.io/github/release-date/peaceiris/mkdocs-material-boilerplate.svg)](https://github.com/peaceiris/mkdocs-material-boilerplate/releases)

[![GitHub Actions status](https://github.com/peaceiris/mkdocs-material-boilerplate/workflows/github%20pages/badge.svg)](https://github.com/peaceiris/mkdocs-material-boilerplate/actions)

[![Netlify Status](https://api.netlify.com/api/v1/badges/9c95ccf4-5c1e-447b-8025-dd0b6f8764a5/deploy-status)](https://app.netlify.com/sites/mkdocs-material/deploys)

## Details

Read more 👉 [Documentation - MkDocs Material Boilerplate]

[Documentation - MkDocs Material Boilerplate]: https://peaceiris.github.io/mkdocs-material-boilerplate/

## Quick start

```sh

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]

[mkdocs/mkdocs: Project documentation with Markdown - GitHub]: https://github.com/mkdocs/mkdocs/

[squidfunk/mkdocs-material: A Material Design theme for MkDocs]: https://github.com/squidfunk/mkdocs-material

## License

- [MIT License]

- [The graduate cap icon] made by [Freepik] from [www.flaticon.com] is licensed by [CC 3.0 BY]

[MIT License]: https://github.com/peaceiris/mkdocs-material-boilerplate/blob/main/LICENSE

[The graduate cap icon]: https://www.flaticon.com/free-icon/graduate-cap_62627

[Freepik]: https://www.freepik.com/

[www.flaticon.com]: https://www.flaticon.com/

[CC 3.0 BY]: http://creativecommons.org/licenses/by/3.0/

## About Maintainer

- [peaceiris Homepage](https://peaceiris.com/)