Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nelsonjchen authored Oct 15, 2020
1 parent 4d8355b commit 9fa43eb
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ in the virtual environment your pelican site is developed in.
## Environment variables

- `GH_PAGES_BRANCH` (optional): override the default `gh-pages` deployment branch
- `PELICAN_CONFIG_FILE` (optional): override the default `pelicanconf.py` config file
- `PELICAN_CONFIG_FILE` (optional): override the default `pelicanconf.py` config file
- `GITHUB_TOKEN`: (required) should be `${{secrets.GITHUB_TOKEN}}`, see [the workflow demo in the demo repository for an example of this][workflow_demo].

## Demo

Expand All @@ -27,3 +28,4 @@ It is not used there anymore though. For most sites though, this should
suffice.

[1]: https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys
[workflow_demo]: https://github.com/nelsonjchen/pelican-action-demo/blob/98ad1a776e95d05b0658a179c4d28e20c353bba4/.github/workflows/pelican.yml#L19

0 comments on commit 9fa43eb

Please sign in to comment.