Skip to content
This repository has been archived by the owner on Mar 31, 2021. It is now read-only.
/ jquery-gh-readme Public archive

A jQuery plugin for rendering a readme.md in Github file as html.

License

Notifications You must be signed in to change notification settings

zmckinnon/jquery-gh-readme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

jquery.gh-readme Build Status

A jQuery plugin for rendering a readme.md in Github file as html.

Installation

bower install jquery-gh-readme

Usage

<div id="readme"></div>
<script src="/bower_components/jquery/dist/jquery.js"></script>
<script src="/bower_components/jquery-gh-readme/dist/jquery.gh-readme.min.js"></script>
<script>
	$(function () {
		var options = {
			owner: 'zmckinnon',
			repo: 'jquery-gh-readme'
		};
		$('#readme').readme(options);
	});
</script>