No description, website, or topics provided.
JavaScript
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
API.md
README.md
index._js
index.md
package.json

README.md

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.