personalgh / Repo.js

:page_facing_up: A plugin to embed Github repos on your site

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Repo.js

Repo.js is a jQuery plugin that lets you easily embed a Github repo onto your site. This is great for other plugin or library authors that want to showcase the contents of a repo on their project pages.

Repo.js uses Markus Ekwall's jQuery Vangogh plugin for styling of file contents. Vangogh, subsequently, utilizes highlight.js, written by Ivan Sagalaev for syntax highlighting.

Example Usage

$('body').repo({ user: 'darcyclarke', name: 'Repo.js' })

You can also reference a specific branch if you want:

$('body').repo({ user: 'jquery', name: 'jquery', branch: 'strip_iife' })

About

:page_facing_up: A plugin to embed Github repos on your site

License:MIT License