aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2021-11-04 19:32:06 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2021-11-05 13:01:33 +0300
commitea2cac77bbb0b01b42e4c50acf733056141fcd83 (patch)
tree22af069250b139c541dfbd3b3d62c73ca6a94843 /README.md
parentREADME: fix a typo (diff)
downloadjekyll-theme-ea2cac77bbb0b01b42e4c50acf733056141fcd83.tar.gz
jekyll-theme-ea2cac77bbb0b01b42e4c50acf733056141fcd83.zip
pick up default site.settings values from site.github
Also, use the default filter more, it's much more convenient.
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/README.md b/README.md
index dc1a448..cfb8eec 100644
--- a/README.md
+++ b/README.md
@@ -28,7 +28,7 @@ Put it in \_config.yml and adjust how you see fit.
```
settings:
project:
- name: Test
+ name: Test project
description: This is a test project
license: MIT License
license_file: LICENSE.txt
@@ -37,6 +37,9 @@ settings:
email: John.Doe@example.com
navbar:
hide: false
+ github: # Only relevant if you use jekyll-github-metadata/github-pages
+ link: GitHub
+ icon: globe
```
Features