1.0.2 • Published 4 years ago
generate-react-doc v1.0.2
React documentation generator
A React documentation generator CLI utility.
How to install
npm install -g generate-react-doc
Usage
generate-react-doc [TARGETS] [DOCS_FOLDER]
Arguments
- TARGETS: The files/folders you'd like to generate documentation from
- DOCS_FOLDER: The destination folder for the resulting documentation files.
Generating documentation
This CLI tool makes use of react-docgen and react-docgen-markdown-renderer in order to generate documentation files. For more info on how to format your components in order to generate those docs, please refer to react-docgen