diff options
Diffstat (limited to '_drafts/2020-09-28-github-metadata.md')
-rw-r--r-- | _drafts/2020-09-28-github-metadata.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/_drafts/2020-09-28-github-metadata.md b/_drafts/2020-09-28-github-metadata.md new file mode 100644 index 0000000..02c5072 --- /dev/null +++ b/_drafts/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 %}
\ No newline at end of file |