jDoc

jDoc is a simple and fast framework for building html pages in client browser.

Table of contents

• Quick start
• Example
• Featuress
• Installation
• Samples
• More Information
• Versioning
• Creators
• Copyright and license

Quick start

jDoc needs html file for main structure of page and a meta file to call resources, maps links and urls and builds page on client browser.

Meta file is a json file, similar page name, with extention of '.meta.json'.

You don't need any reference for meta file on your html page. when you call a page, for example 'index.html', meta file with name of 'index.meta.json' is also loaded with page and then jDoc renders and builds your page on browser.

For use jDoc, first you need to reference jquery library.

<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/4.0.0/jquery.min.js"></script>
<script src="/dist/jdoc.js"></script>

Reference jdoc.js and then call jDoc.view() method.

$(document).ready(function() {
	jDoc.view();
});

Example

For example, you have a html file with name of "index.html" on your server and you want load "nav.html" page inside a div element.

First, you put a code like this on your "index.html":

<div id="nav"></div>

Create new json file with name of "index.meta.json" in same folder of "index.html":

{
	"id": "",
	"include": [
		{
			"id": "nav",
			"type": "url",
			"value": "nav.html"
		}
	]
}

Create new html file with name of "nav.html".

put all files on the web server.

Now, you can call index.html on client.

See Codes

Featuress

• Event Manager - jDoc manages events by creating links between events and elements.
• Data Manager - In jDoc, data is seprated from page. Data is managed in json format by jDoc.

Installation

npm install @bssyco/jdoc

Versioning

See the Releases section of our GitHub project

Creators

PS bssyco

Parviz Taghavi [email protected]

• https://github.com/bssyco
• https://jdoc.bssyco.com

Samples

For more Samples see: Example

More Information

About project: jDoc project page

Copyright and license

Code and documentation copyright 2026 the Bssyco Authors. Code released under the MIT License.