• Status badges
• Getting started
  • Docker
  • pipenv
  • pip (conda)
• Host on GitHub Pages
  • Build with mkdocs gh-deploy
    • Deploy with docker
    • Deploy with pipenv
  • Build and deploy with CircleCI
  • Build with GitHub Actions
• Host on GitLab Pages
• Host on Netlify
• Host on AWS Amplify Console
• Links
• License
• Support Author

git clone https://github.com/peaceiris/mkdocs-material-boilerplate.git
cd mkdocs-material-boilerplate

• peaceiris/mkdocs-material - Docker Hub

docker pull peaceiris/mkdocs-material
./task.sh -s  # mkdocs serve
./task.sh -b  # mkdocs build
./task.sh -d  # mkdocs gh-deploy
./task.sh -V  # mkdocs --version
./task.sh -h  # mkdocs --help

Serving on localhost:8000

pipenv sync
pipenv run version    # mkdocs --version
pipenv run help       # mkdocs --help
pipenv run serve      # mkdocs serve
pipenv run build      # mkdocs build
pipenv run gh-deploy  # mkdocs gh-deploy

pip install -r requirements.txt

• Demo site on GitHub Pages (build & deploy with CircleCI)

1. Create a Personal access token. (Check only repo)
2. Run the following scripts.

./task.sh -d  # mkdocs gh-deploy
# Enter github username
# Enter the Personal access token

pipenv run gh-deploy  # mkdocs gh-deploy

• Set these Environment Variables.
  • USER_NAME: GitHub ID
  • USER_EMAIL: Email
  • GITHUB_TOKEN: Personal access token

TBW.

• peaceiris/mkdocs-material-boilerplate - GitLab
• Demo site on GitLab Pages (build & deploy with GitLab CI/CD)

• Demo site on Netlify (build & deploy with Netlify)

Create GitHub repository and deploy to Netlify in 1 min.

• Demo site on Amplify Console (build & deploy with Amplify Console)
  • ID: github
  • Password: OhGhiNu5On5Ohzuva6ma

You can use Password protection. Set TTL to 600 sec.

• mkdocs/mkdocs: Project documentation with Markdown - GitHub
• squidfunk/mkdocs-material: A Material Design theme for MkDocs
• peaceiris/mkdocs-material - Docker Hub
• peaceiris/mkdocs-material-boilerplate - GitLab
• Demo site on GitHub Pages
• Demo site on GitLab Pages
• Demo site on Netlify
• Demo site on Amplify Console

• MIT License
• The graduate cap icon made by Freepik from www.flaticon.com is licensed by CC 3.0 BY

• Amazon wish list