streamline-doctool
v0.1.6
Published
simple documentation tool for streamline.js
Downloads
5
Readme
Simple documentation tool
streamline-doctool
is a simple (minimal) documentation tool for JavaScript and streamline.js modules.
streamline-doctool
relies heavily on markdown. It works by extracting documentation in markdown syntax from comment blocks. To get started you only need to know one directive:
/// !doc
: Turns documentation on. Any line that starts with ///
(3 slashes followed by a space - may be indented) will be extracted and appended to the documentation file.
Installation
npm install streamline-doctool
License
This work is licensed under the MIT license.