Skip to content

Latest commit

 

History

History
35 lines (31 loc) · 1.29 KB

2020-09-28-github-metadata.md

File metadata and controls

35 lines (31 loc) · 1.29 KB
layout title date description categories
post
a post with github metadata
2020-09-28 14:01:00 -0700
a quick run down on accessing github metadata.
sample-posts external-services

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 authentication.
  • Go through this README for more details on the topic.
  • This page highlights all the feilds you can access with github-metadata.

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 %}