Lightweight jQuery Based API Documentation Generator - jqGuide

File Size: 18.5 KB
Views Total: 995
Last Update:
Publish Date:
Official Website: Go to website
License: MIT
Lightweight jQuery Based API Documentation Generator - jqGuide

jqGuide is a tiny and easy-to-use jQuery plugin that helps you generate a beautiful one page API / guide / function documentation from JSON objects.

How to use it:

1. Include the jQuery jqGuide plugin's style sheet in the head for core CSS styles.

<link rel="stylesheet" href="assets/css/gen-style.css">

2. Prepare your data for the documentation following the JSON data structure like this:

    "description":"Logs all changes brought to a handsontable instance",
        "definition":"reads data from the handsontable change object",
        "definition":"text value of the table sending the log",
        "definition":"what method has sent the log data",

3. Include jQuery JavaScript library and the jQuery jqGuide plugin's JavaScript file on the webpage where needed.

<script src="jquery.min.js"></script>
<script src="jqGuide.js"></script>

4. Initialize the plugin to generate an API documentation from 'functions.json'.


5. Default parameters for the plugin.

// data source folder

// data file
jsonSourceData: null,

// parent container
parentItem: null,

// Generates a side navigation

// Shows a document scroll progress bar

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