Skip to content
MkDocs Material Boilerplate (Starter Kit) - Deploy documentation to hosting platforms (Netlify, GitHub Pages, GitLab Pages, and AWS Amplify Console) with CircleCI, Docker, pipenv, and CI/CD
Shell Dockerfile
Branch: master
Clone or download
Pull request Compare This branch is 5 commits ahead, 75 commits behind peaceiris:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
docs
images
.dockerignore
.gitignore
.gitlab-ci.yml
Dockerfile
LICENSE
Pipfile
Pipfile.lock
README.md
amplify.yml
mkdocs.yml
netlify.toml
requirements.txt
runtime.txt
task.sh

README.md

Front-End Checklist
MkDocs Material
Boilerplate - Starter Kit

material.png

Table of Contents

Status badges

Click to expand 👈
  • license
  • GitHub
    • release
    • github release date
    • GitHub All Releases
    • CircleCI status badge
  • GitLab
    • Gitlab pipeline status
  • Netlify
    • Netlify Status
  • Docker
    • docker pulls
    • docker stars
    • docker image size

Getting started

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

Docker

DockerHub Badge

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

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 (conda)

pip install -r requirements.txt

Host on GitHub Pages

Build with mkdocs gh-deploy

Deploy with docker

  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

Deploy with pipenv

pipenv run gh-deploy  # mkdocs gh-deploy

Build and deploy with CircleCI

  • Set these Environment Variables.

Build with GitHub Actions

TBW.

Host on GitLab Pages

Host on Netlify

Create GitHub repository and deploy to Netlify in 1 min.

Deploy to Netlify from GitHub

Host on AWS Amplify Console

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

Links

License

Support Author

You can’t perform that action at this time.