pages/_posts/2020-09-28-github-metadata.md
Amir Pourmand 6b0bf87846
add jekyll target blank plugin (#404)
* add jekyll target blank

* Remove manual target blank from everywhere

* Update README.md

* Set ruby version to 3.0.2 in the deploy script

Co-authored-by: Maruan Al-Shedivat <maruan@genesistherapeutics.ai>
2021-10-03 21:16:05 -04:00

1.2 KiB

layout title date description
post a post with github metadata 2020-09-28 21:01:00 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 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 %}