https://github.com/peaceiris/actions-mkdocs-gh-pages

GitHub Actions for MkDocs and GitHub Pages - Build markdown documentation with Material for MkDocs and deploy to GitHub Pages automatically
https://github.com/peaceiris/actions-mkdocs-gh-pages

github-actions github-pages mkdocs mkdocs-material

Last synced: about 1 year ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/peaceiris/actions-mkdocs-gh-pages
• Owner: peaceiris
• License: mit
• Archived: true
• Created: 2019-04-25T20:24:14.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2019-10-15T22:44:49.000Z (over 6 years ago)
• Last Synced: 2024-10-30T07:47:46.402Z (over 1 year ago)
• Topics: github-actions, github-pages, mkdocs, mkdocs-material
• Language: Shell
• Homepage:
• Size: 229 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
This repository will not be updated in the future.

Please, use the following GitHub Actions.

- [peaceiris/actions-gh-pages: GitHub Actions for deploying to GitHub Pages with Static Site Generators](https://github.com/peaceiris/actions-gh-pages)

Click to expand the old README

[![license](https://img.shields.io/github/license/peaceiris/actions-mkdocs-gh-pages.svg)](https://github.com/peaceiris/actions-mkdocs-gh-pages/blob/master/LICENSE)

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

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

## GitHub Actions for MkDocs and GitHub Pages

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

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

![material.png](https://raw.githubusercontent.com/peaceiris/actions-mkdocs-gh-pages/master/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

[peaceiris/mkdocs-material-boilerplate: MkDocs Material Boilerplate (Starter Kit)]: https://github.com/peaceiris/mkdocs-material-boilerplate

## 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

```hcl

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]

[MIT License - peaceiris/actions-mkdocs-gh-pages]: https://github.com/peaceiris/actions-mkdocs-gh-pages/blob/master/LICENSE

## About the author

- [peaceiris's homepage](https://peaceiris.com/)