aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2021-11-02 20:57:05 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2021-11-02 21:01:14 +0300
commit513dd2010502a4519db11bf6f54584047b024949 (patch)
tree520b57424c366f8ef7239269caa1049a1ae232a3 /README.md
parentbump dependencies (diff)
downloadjekyll-theme-513dd2010502a4519db11bf6f54584047b024949.tar.gz
jekyll-theme-513dd2010502a4519db11bf6f54584047b024949.zip
navbar: add a GitHub link
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index 291b79d..a719f6d 100644
--- a/README.md
+++ b/README.md
@@ -62,6 +62,13 @@ something like `home` or `envelope` (or [any other glyphicon]).
[any other glyphicon]: https://getbootstrap.com/docs/3.4/components/#glyphicons
+If you use `jekyll-github-metadata` (you do if you use the `github-pages` gem),
+a link to the GitHub repository is added at the end of the navbar.
+Customize the link text and the icon by setting
+`site.settings.navbar.github.link` and `site.settings.navbar.github.icon`
+accordingly.
+Hide the link by settings `site.settings.navbar.github` to `false`.
+
### Post feed
See [feed/index.html] for an example of how to easily create a paginated post