TC pushbot 5 7910c0b742 Added legacy (beta) documentation 4 years ago
..
chapter 7910c0b742 Added legacy (beta) documentation 4 years ago
css c22fbc3fec Added documentation engine 4 years ago
img 7910c0b742 Added legacy (beta) documentation 4 years ago
reader 2015d47b84 Updated documentation 4 years ago
README.md 7910c0b742 Added legacy (beta) documentation 4 years ago
index.html 7910c0b742 Added legacy (beta) documentation 4 years ago
showdown.min.js c22fbc3fec Added documentation engine 4 years ago
showdown.min.js.map c22fbc3fec Added documentation engine 4 years ago

README.md

ArOZ Online Documentation Rendering Interface

This is the documentation rendering script for ArOZ Online Documentation System. The json files follow the following structure

How it works

It works by passing the lanauge into the html file as hash and ask the script to search all the JSON files which contain the content of the documentation in the respective directories.

Structure

The first line is the meta tag in JSON string format and the rest of the document is in markdown format. For example:

["Hello World!"]
# This is a document file for the ArOZ Online System
More lines here

The reader.php will then render the JSON content into css + HTML. All image should be placed inside /img directory under the /docs documentation root folder.