kganser.com

doc.js

Doc.js is a simple inline documentation parser written in javascript for javascript. It uses jscc to parse a custom javascript spec syntax from comments in source code.

Installation

Use the doc-jsml wrapper script and stylesheet to render documentation in-browser from a script document requested via ajax. This script uses jsml to render json output from the doc.js library script as DOM.

<!-- in head tag -->
<link rel="stylesheet" href="http://docjs.kganser.com/doc-jsml.css">

<div id="docs"></div>

<!-- before closing body tag -->
<script src="http://jsml.kganser.com/jsml.js"></script>
<script src="http://docjs.kganser.com/doc.js"></script>
<script src="http://docjs.kganser.com/doc-jsml.js"></script>
<script>
  doc('/doc-jsml.js', document.getElementById('docs'));
</script>

Library