diff options
| author | Thomas Chamberlin <tchamberlin@users.noreply.github.com> | 2018-05-26 23:27:21 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-05-26 23:27:21 -0400 |
| commit | 79bb82bc26a0c2d20a8da5de936eca629faf5e18 (patch) | |
| tree | 477806287132414ed53a652ea0026ef24e65d253 | |
| parent | 7da0be48840a80891b85aacf03d67b42852fc343 (diff) | |
| download | pelican-themes-79bb82bc26a0c2d20a8da5de936eca629faf5e18.tar.gz | |
Further wording change to README'S Github section
Reworded a few things for clarity
| -rw-r--r-- | pelican-bootstrap3/README.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/pelican-bootstrap3/README.md b/pelican-bootstrap3/README.md index d3eeec0..19ba361 100644 --- a/pelican-bootstrap3/README.md +++ b/pelican-bootstrap3/README.md @@ -317,9 +317,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`: 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_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 In order to make the Facebook like button and other social sharing options work better, the template contains Open Graph metatags like `<meta property="og:type" content="article"/>`. You can disable them by setting `USE_OPEN_GRAPH` to _False_. You can use `OPEN_GRAPH_FB_APP_ID` to provide a Facebook _app id_. |