diff options
| author | Thomas Chamberlin <tchamberlin@users.noreply.github.com> | 2018-05-26 23:19:07 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-05-26 23:19:07 -0400 |
| commit | 7da0be48840a80891b85aacf03d67b42852fc343 (patch) | |
| tree | b217d5c94b48cce1cfbd898e4bc0d3f5181727c9 | |
| parent | 8b244609f5f6fcce30c5324cfa8b1e5c4df0e199 (diff) | |
| download | pelican-themes-7da0be48840a80891b85aacf03d67b42852fc343.tar.gz | |
Updated README's Github section
There are no descriptions of how the various options work, and they don't work in entirely intuitive ways. I've gone through the relevant code and derived what I think are accurate descriptions of what each does.
`GITHUB_SKIP_FORK` especially is confusing, because passing it a boolean will break it.
| -rw-r--r-- | pelican-bootstrap3/README.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/pelican-bootstrap3/README.md b/pelican-bootstrap3/README.md index 27b9d7a..d3eeec0 100644 --- a/pelican-bootstrap3/README.md +++ b/pelican-bootstrap3/README.md @@ -316,9 +316,9 @@ For example, if you want to use the WTFPL license, you can set: The theme can show your most recently active GitHub repos in the sidebar. To enable, provide a `GITHUB_USER`. Appearance and behaviour can be controlled using the following variables: -* `GITHUB_REPO_COUNT` -* `GITHUB_SKIP_FORK` -* `GITHUB_SHOW_USER_LINK` +* `GITHUB_REPO_COUNT`: An integer representing the number of repos to display (sorted by modification date, descending) +* `GITHUB_SKIP_FORK`: Either 'false' [default] or 'true'. If 'true', exclude forked repositories from display in the sidebar. NOTE: This cannot be set to `True` or `False`, it must be a string representation of JS's `true`/`false`. +* `GITHUB_SHOW_USER_LINK`: If undefined [default], don't show a link to the `GITHUB_USER`'s user page. If defined, show it. ### Facebook Open Graph |