streamline-doctool

0.1.6 • Public • Published

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.

/streamline-doctool/

    Package Sidebar

    Install

    npm i streamline-doctool

    Weekly Downloads

    2

    Version

    0.1.6

    License

    none

    Last publish

    Collaborators

    • bjouhier