8000 Docs: use plugins config key (#115) · inntran/github-metadata@e48150e · GitHub
[go: up one dir, main page]

Skip to content

Commit e48150e

Browse files
Pilabiojekyllbot
authored andcommitted
Docs: use plugins config key (jekyll#115)
Merge pull request 115
1 parent 94cc44e commit e48150e

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,18 @@ Jekyll plugin to propagate the `site.github` namespace and set default values fo
1717
Usage of this gem is pretty straight-forward. Add it to your bundle like this:
1818

1919
```ruby
20-
gem 'jekyll-github-metadata'
20+
gem "jekyll-github-metadata"
2121
```
2222

2323
Now add it to your `_config.yml`:
2424

2525
```yaml
26-
gems:
27-
- jekyll-github-metadata
26+
plugins:
27+
- "jekyll-github-metadata"
2828
```
2929
30+
:warning:If you are using Jekyll < 3.5.0 use the gems key instead of plugins.
31+
3032
Then go ahead and run `bundle install`. Once you've done that jekyll-github-metadata will run when you run Jekyll.
3133

3234

0 commit comments

Comments
 (0)
0