https://github.com/darcyclarke/Repo.js

:page_facing_up: A plugin to embed Github repos on your site
https://github.com/darcyclarke/Repo.js

github javascript repo repository

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/darcyclarke/Repo.js
• Owner: darcyclarke
• License: mit
• Created: 2012-06-24T23:03:30.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2024-05-30T16:46:26.000Z (4 months ago)
• Last Synced: 2024-07-04T13:07:55.825Z (3 months ago)
• Topics: github, javascript, repo, repository
• Homepage:
• Size: 212 KB
• Stars: 910
• Watchers: 23
• Forks: 82
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
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](https://twitter.com/#!/mekwall)'s [jQuery Vangogh](https://github.com/mekwall/jquery-vangogh) plugin for styling of file contents. Vangogh, subsequently, utilizes [highlight.js](https://github.com/isagalaev/highlight.js), written by [Ivan Sagalaev](https://github.com/isagalaev) for syntax highlighting.

## Example Usage

```js

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

```

You can also reference a specific branch if you want:

```js

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

```