Generates HTML Page From Github README.md - jQuery gh-readme

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

The gh-readme jQuery plugin dynamically fetches Readme.md 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 README.md 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="https://code.jquery.com/jquery-3.3.1.min.js" 
        integrity="sha384-tsQFqpEReu7ZLhBV2VZlAu7zcOV+rXbYlF2cqB8txI/8aZajjp4Bqd+V6D5IgvKT" 
        crossorigin="anonymous">
</script>
<script src="jquery.gh-readme.min.js"></script>

2. Create a container in which you want to render the Readme.md 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'
  };
  $('#readme').readme(options);
});

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