diff options
| author | Justin Mayer <entroP@gmail.com> | 2018-09-01 19:32:17 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-09-01 19:32:17 +0200 |
| commit | 1218221da141ee7b62947757c2e7dd87398c630b (patch) | |
| tree | f3251b16e83e3c07665cc5379d7b62a44dc14a3a | |
| parent | f741c9c23b442b5a8a659bb804944276a0086e8b (diff) | |
| parent | 79bb82bc26a0c2d20a8da5de936eca629faf5e18 (diff) | |
| download | pelican-themes-1218221da141ee7b62947757c2e7dd87398c630b.tar.gz | |
Merge pull request #600 from tchamberlin/patch-1
Updated pelican-bootstrap3 README's Github section
| -rw-r--r-- | pelican-bootstrap3/README.md | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/pelican-bootstrap3/README.md b/pelican-bootstrap3/README.md index d41ef54..d990004 100644 --- a/pelican-bootstrap3/README.md +++ b/pelican-bootstrap3/README.md @@ -318,9 +318,11 @@ 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. +* `GITHUB_SHOW_USER_LINK`: If undefined [default], don't show a link to the `GITHUB_USER`'s user page. If defined, show it. + +NOTE: Boolean values will _not_ work here! They will be interpreted as literal strings by JS, so instead use `'true'` and `'false'` ### Facebook Open Graph |