Generates HTML Page From Github - jQuery gh-readme

File Size: 20.3 KB
Views Total: 407
Last Update:
Publish Date:
Official Website: Go to website
License: MIT
Generates HTML Page From Github - jQuery gh-readme

The gh-readme jQuery plugin dynamically fetches file from your Github repository and renders the README content as HTML on the webpage.

Can be used as a dynamic site creator that helps developers to generate a documentation page from the file of the repository.

How to use it:

1. Load the minified version of the jQuery gh-readme plugin after loading jQuery library.

<script src="" 
<script src=""></script>

2. Create a container in which you want to render the file.

<div id="readme"></div>

3. Call the function on the container element and specify the Github username & repository name.

$(function () {
  var options = {
    owner: 'jqueryscript',
    repo: 'safe-delete'

This awesome jQuery plugin is developed by zmckinnon. For more Advanced Usages, please check the demo page or visit the official website.