Github MetaData (#121)
* Feature Request : https://github.com/alshedivat/al-folio/issues/85 * Added github-metadata dependency : https://github.com/jekyll/github-metadata * Created sample blog quickly going over Github MetaData. Co-authored-by: Maruan <alshedivat@users.noreply.github.com>
This commit is contained in:
parent
f92f466117
commit
a734d4a4bc
1
Gemfile
1
Gemfile
|
|
@ -3,6 +3,7 @@ group :jekyll_plugins do
|
||||||
gem 'github-pages'
|
gem 'github-pages'
|
||||||
gem 'jekyll'
|
gem 'jekyll'
|
||||||
gem 'jekyll-email-protect'
|
gem 'jekyll-email-protect'
|
||||||
|
gem 'jekyll-github-metadata'
|
||||||
gem 'jekyll-paginate-v2'
|
gem 'jekyll-paginate-v2'
|
||||||
gem 'jekyll-scholar'
|
gem 'jekyll-scholar'
|
||||||
gem 'jekyll-twitter-plugin'
|
gem 'jekyll-twitter-plugin'
|
||||||
|
|
|
||||||
|
|
@ -111,10 +111,11 @@ exclude: [vendor]
|
||||||
# Plug-ins
|
# Plug-ins
|
||||||
plugins:
|
plugins:
|
||||||
- jekyll-email-protect
|
- jekyll-email-protect
|
||||||
|
- jekyll-github-metadata
|
||||||
- jekyll-paginate-v2
|
- jekyll-paginate-v2
|
||||||
- jekyll/scholar
|
- jekyll/scholar
|
||||||
|
- jekyll-twitter-plugin
|
||||||
- jemoji
|
- jemoji
|
||||||
- 'jekyll-twitter-plugin'
|
|
||||||
# - bootstrap
|
# - bootstrap
|
||||||
# - material-sass
|
# - material-sass
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,34 @@
|
||||||
|
---
|
||||||
|
layout: post
|
||||||
|
title: a post with github metadata
|
||||||
|
date: 2020-09-28 21:01:00
|
||||||
|
description: a quick run down on accessing github metadata.
|
||||||
|
---
|
||||||
|
|
||||||
|
A sample blog page that demonstrates the accessing of github meta data.
|
||||||
|
|
||||||
|
## What does Github-MetaData do?
|
||||||
|
* Propagates the site.github namespace with repository metadata
|
||||||
|
* Setting site variables :
|
||||||
|
* site.title
|
||||||
|
* site.description
|
||||||
|
* site.url
|
||||||
|
* site.baseurl
|
||||||
|
* Accessing the metadata - duh.
|
||||||
|
* Generating edittable links.
|
||||||
|
|
||||||
|
## Additional Reading
|
||||||
|
* If you're recieving incorrect/missing data, you may need to perform a Github API<a href="https://github.com/jekyll/github-metadata/blob/master/docs/authentication.md"> authentication</a>.
|
||||||
|
* Go through this <a href="https://jekyll.github.io/github-metadata/" target="blank">README</a> for more details on the topic.
|
||||||
|
* <a href= "https://github.com/jekyll/github-metadata/blob/master/docs/site.github.md">This page</a> highlights all the feilds you can access with github-metadata.
|
||||||
|
<br />
|
||||||
|
|
||||||
|
## Example MetaData
|
||||||
|
* Host Name : {{ site.github.hostname }}
|
||||||
|
* URL : {{ site.github.url }}
|
||||||
|
* BaseURL : {{ site.github.baseurl }}
|
||||||
|
* Archived : {{ site.github.archived}}
|
||||||
|
* Contributors :
|
||||||
|
{% for contributor in site.github.contributors %}
|
||||||
|
* {{ contributor.login }}
|
||||||
|
{% endfor %}
|
||||||
Loading…
Reference in New Issue