Github MetaData (alshedivat#121)

* Feature Request : alshedivat#85 * Added github-metadata dependency : https://github.com/jekyll/github-metadata * Created sample blog quickly going over Github MetaData. Co-authored-by: Maruan <[email protected]>
niftrr · Oct 3, 2020 · a734d4a · a734d4a
1 parent f92f466
commit a734d4a
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 1 deletion.
diff --git a/Gemfile b/Gemfile
@@ -3,6 +3,7 @@ group :jekyll_plugins do
     gem 'github-pages'
     gem 'jekyll'
     gem 'jekyll-email-protect'
+    gem 'jekyll-github-metadata'
     gem 'jekyll-paginate-v2'
     gem 'jekyll-scholar'
     gem 'jekyll-twitter-plugin'

diff --git a/_config.yml b/_config.yml
@@ -111,10 +111,11 @@ exclude: [vendor]
 # Plug-ins
 plugins:
   - jekyll-email-protect
+  - jekyll-github-metadata
   - jekyll-paginate-v2
   - jekyll/scholar
+  - jekyll-twitter-plugin
   - jemoji
-  - 'jekyll-twitter-plugin'
   # - bootstrap
   # - material-sass
 

diff --git a/_posts/2020-09-28-github-metadata.md b/_posts/2020-09-28-github-metadata.md
@@ -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 %}