extract-docs

A simple CLI tool to gather documentation from JS code

Installation

$ npm install --save-dev extract-docs

Usage

Use this tiny tool to extract comments from your JS code and insert them in a template. The template would look like this:

Bla bla bla...

[[[./lib/myLib.js]]]

Bla bla bla...

And your comments in ./lib/myLib.js should look like this (note the -- prefix):

// -- ## foo()
// -- This documentation will be extracted.
export function foo() {
    // This will not appear in the extracted documentation
    // ...
}

You can also use block comments:

/* --
## foo()
This documentation will be extracted.
-- */
export function foo() {
    // This will not appear in the extracted documentation
    // ...
}

Or if you want to re-use code as documentation:

/* -- START_DOCS -- */
type Options = {
  height?: number,
  width?: number,
};
/* -- END_DOCS -- */

Run the tool as follows:

$ extract-docs --template README_TEMPLATE.md --output README.md

MIT license

Copyright (c) Guillermo Grau Panea 2016-present

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.