Skip to content

Commit

Permalink
replace: GitHub Actions
Browse files Browse the repository at this point in the history
  • Loading branch information
peaceiris committed Apr 25, 2019
1 parent 775a812 commit b829221
Show file tree
Hide file tree
Showing 5 changed files with 3 additions and 96 deletions.
17 changes: 0 additions & 17 deletions .github/mkdocs/Dockerfile

This file was deleted.

33 changes: 0 additions & 33 deletions .github/mkdocs/README.md

This file was deleted.

25 changes: 0 additions & 25 deletions .github/mkdocs/entrypoint.sh

This file was deleted.

2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,11 @@ inv serve

- [mkdocs/mkdocs: Project documentation with Markdown - GitHub]
- [squidfunk/mkdocs-material: A Material Design theme for MkDocs]
- [peaceiris/actions-mkdocs-gh-pages: GitHub Actions for MkDocs and GitHub Pages]

[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
[peaceiris/actions-mkdocs-gh-pages: GitHub Actions for MkDocs and GitHub Pages]: https://github.com/peaceiris/actions-mkdocs-gh-pages



Expand Down
22 changes: 1 addition & 21 deletions docs/hosting-and-deployment/github-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,7 @@

## Build and deploy with GitHub Actions

### (1) Add deploy Key

1. Generate deploy key `ssh-keygen -t rsa -f mkdocs -q -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) Push `.github`

```
.github
├── main.workflow
└── mkdocs
├── Dockerfile
└── entrypoint.sh
```

### (3) Update releases

When you push to master branch, GitHub Actions runs.
- [GitHub Actions for MkDocs and GitHub Pages - Build markdown documentation with Material for MkDocs and push to GitHub Pages with GitHub Actions](https://github.com/peaceiris/actions-mkdocs-gh-pages)



Expand Down

0 comments on commit b829221

Please sign in to comment.