aboutsummaryrefslogtreecommitdiffstats
path: root/pelican-bootstrap3
diff options
context:
space:
mode:
Diffstat (limited to 'pelican-bootstrap3')
-rw-r--r--pelican-bootstrap3/README.md6
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