devashishmamgain / jquery-gh-readme

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

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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>

About

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

License:MIT License


Languages

Language:JavaScript 97.6%Language:HTML 2.4%