1.0.1 • Published 7 years ago

foxydoc v1.0.1

Weekly downloads
-
License
ISC
Repository
-
Last release
7 years ago

FoxyDoc

Docblock parser with custom tags. Automatically generates markdown files.

Allows any type of docblock tag e.g. @param, @option, @foo, @bar

Install

npm install -g foxydoc

Usage

foxydoc --included-paths foo bar --exclude-pattern demo --output-directory docs

Command Line Arguments

NameTypeDescription
--included-pathsArrayPaths to generate from
--exclude-patternStringRegex pattern to exclude
--output-directoryStringLocation of markdown output