Update README.md

This commit is contained in:
Andrew Banchich 2021-04-04 13:47:28 -04:00 committed by GitHub
parent 44d7e19665
commit 016dccfe7d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions

View File

@ -11,7 +11,11 @@ or read up on just the basics of [front matter](https://jekyllrb.com/docs/frontm
and [creating pages](https://jekyllrb.com/docs/pages/).
- **GitLab**: Simply fork this repository and start editing the `_config.yml` file!
- **GitHub**: Fork this repository, set up a Personal Access Token ([instructions](https://jekyllrb.com/docs/continuous-integration/github-actions/#providing-permissions)) named `JEKYLL_PAT`, set GitHub Pages (in repo settings) to use `gh-pages` branch, and start editing the `_config.yml` file!
- **GitHub**:
1. Fork this repository.
2. Set up a Personal Access Token ([instructions](https://jekyllrb.com/docs/continuous-integration/github-actions/#providing-permissions)) named `JEKYLL_PAT`.
3. The GitHub Actions workflow should have run when you forked the repo. This initial run will fail because of the missing `JEKYLL_PAT` secret not being set. Got to the workflow run and click "re-run all workflows". This time it should succeed.
4. Start editing the `_config.yml` file!
> NOTE: GitHub Actions is required to deploy to GitHub Pages because GitHub [refuses to update their version of Jekyll](https://github.com/github/pages-gem/issues/651).