https://github.com/aapis/jekyll-github

A jekyll plugin to display information from Github
https://github.com/aapis/jekyll-github

Last synced: 23 days ago
JSON representation

A jekyll plugin to display information from Github

• Host: GitHub
• URL: https://github.com/aapis/jekyll-github
• Owner: aapis
• Created: 2015-11-22T01:11:16.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-11-25T05:08:42.000Z (about 9 years ago)
• Last Synced: 2024-10-15T10:29:55.689Z (2 months ago)
• Language: Ruby
• Size: 15.6 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# jekyll-github

Pull information from the Github API and print it on your static Jekyll website.  See [this page](http://ryanpriebe.com/projects) to see exactly what this plugin generates.

Still in progress!

TODO:

* More data options (user, stars, followers, etc)

## Installation

1. Extract the zip file contents to `YOUR_SITE_DIR/_plugins`

2. Run `bundle install` inside `YOUR_SITE_DIR/_plugins/jekyll-github`

3. Get an API key from Github and set them in your bash profile as `GITHUB_TOKEN_USER` and `GITHUB_TOKEN_PASS`

4. Add one of the shortcodes to the page and run `jekyll serve`

## Usage

[Add](http://jekyllrb.com/docs/plugins/#tags) any of the following Liquid tags to your site's pages:

* repos

* repos_short

* user