Skip to content
This repository has been archived by the owner. It is now read-only.
GitHub Actions for MkDocs and GitHub Pages - Build markdown documentation with Material for MkDocs and deploy to GitHub Pages automatically
Shell Dockerfile
Branch: master
Clone or download

Latest commit

Latest commit a4be4cb Oct 15, 2019

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.dockerignore fix: .dockerignore May 16, 2019
Dockerfile upgrade: peaceiris/mkdocs-material to v1.5.0 May 18, 2019
LICENSE upgrade: peaceiris/mkdocs-material to v1.5.0 May 18, 2019
README.md Update README.md Oct 15, 2019
entrypoint.sh fix: build options (#8) May 2, 2019
material.png

README.md

This repository will not be updated in the future.

Please, use the following GitHub Actions.

Click to expand the old README

license release GitHub release date

GitHub Actions for MkDocs and GitHub Pages

Build markdown documentation with Material for MkDocs and deploy to GitHub Pages automatically.

material.png

Sample repository

peaceiris/mkdocs-material-boilerplate: MkDocs Material Boilerplate (Starter Kit)

Deploy documentation to hosting platforms (Netlify, GitHub Pages, GitLab Pages, and AWS Amplify Console) with CircleCI, Docker, pipenv, GitHub Actions

Getting started

(1) Add deploy Key

  1. Generate deploy key ssh-keygen -t rsa -b 4096 -C "your@email.com" -f mkdocs -N ""
  2. Go to "Settings > Deploy Keys" of repository.
  3. Add your public key within "Allow write access" option.
  4. Go to "Settings > Secrets" of repository.
  5. Add your private deploy key as ACTIONS_DEPLOY_KEY

(2) Workflow

workflow "MkDocs workflow" {
  on = "push"
  resolves = ["Build and deploy"]
}

action "branch-filter" {
  uses = "actions/bin/filter@master"
  args = "branch master"
}

action "Build and deploy" {
  needs = "branch-filter"
  uses = "peaceiris/actions-mkdocs-gh-pages@v1.2.0"
  env = {
    MKDOCS_BUILD_OPTIONS = "--config-file ./mkdocs-sample.yml"
  }
  secrets = ["ACTIONS_DEPLOY_KEY"]
}

(3) Push to master branch

When you push to master branch, GitHub Actions runs.

License

MIT License - peaceiris/actions-mkdocs-gh-pages

About the author

You can’t perform that action at this time.