https://github.com/lokarlhorst/githubrepo-octopress

Plugin to display Github Repos in Posts inspired by https://github.com/JoelSutherland/GitHub-jQuery-Repo-Widget
https://github.com/lokarlhorst/githubrepo-octopress

Last synced: about 1 month ago
JSON representation

Plugin to display Github Repos in Posts inspired by https://github.com/JoelSutherland/GitHub-jQuery-Repo-Widget

• Host: GitHub
• URL: https://github.com/lokarlhorst/githubrepo-octopress
• Owner: lokarlhorst
• License: other
• Created: 2013-10-28T12:50:00.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2014-04-09T06:29:57.000Z (over 10 years ago)
• Last Synced: 2024-08-02T16:47:59.233Z (4 months ago)
• Language: Ruby
• Size: 132 KB
• Stars: 6
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• my-awesome-starred - lokarlhorst/githubrepo-octopress - Plugin to display Github Repos in Posts inspired by https://github.com/JoelSutherland/GitHub-jQuery-Repo-Widget (Ruby)

README

        
githubrepo-octopress

====================

Plugin to display Github Repos in Posts for Octopress. The plugin uses

[JoelSutherland/GitHub-jQuery-Repo-Widget](https://github.com/JoelSutherland/GitHub-jQuery-Repo-Widget)

to generate a box for displaying your favourite Github repo in your posts.

### Installation

1. Clone Github jquery Repo Widget to your computer

	```git clone https://github.com/JoelSutherland/GitHub-jQuery-Repo-Widget```

2. Clone githubrepo-octopress to your computer

	```git clone https://github.com/sotsy/githubrepo-octopress```

3. Copy ```jquery.githubRepoWidget.min.js``` in

	```youroctopressfolder/source/javascripts``` and put ```githubwidget.rb``` into ```youroctopressfolder/plugins```

4. Merge ```head.html``` with ```youroctopressfolder/source/_includes/custom/head.html```

### Usage

Shortcode for adding Github Repo to your post

```

{% githubrepo sotsy/githubrepo-octopress %}

```

Make sure you set the full name in the shortcode. Otherwise the .js doesn't find

the correct repo.