✓ NOTICE: This project is currently a WIP ✓

JSDown

📜 Markdown Documentation Generator for JSDoc 📜

Features

• No Configuration
• Feed it JSDoc types and it spits out Markdown
• The following are ignored by default: node_modules/, coverage/, vendor/, *.spec.js, *.min.js, and hidden files.

jsdown

Arguments

jsdown [...options] [files...]

• [files] - File(s) to lint (default **/!(index).js)

Usage

# generate documentation
jsdown

```sh
# generate documentation (matching a different file(s))
jsdown '**/!(*.spec|index).cjs'

Note: In Linux/OSX, matcher patterns must be delimited in quotes.