simple-react-docgen
v1.1.1
Published
Generate simple React components documentation in Markdown
Downloads
5
Readme
simple-react-docgen
Generate simple React components documentation in Markdown.
Usage
Example:
$ simple-react-docgen src -o DOC.md
Check every option runnig simple-react-docgen
with --help
or -h
:
$ simple-react-docgen --help
Usage: simple-react-docgen [paths]... [options]
paths Component files or directories. If nothing is provided it reads from stdin.
Options:
-x, --extension File extensions to consider. Repeat to define multiple extensions. Default: [js,jsx]
-e, --exclude Filename patterns to exclude. Default: []
-i, --ignore Folders to ignore. Default: [node_modules,__tests__,__mocks__]
-o FILE, --output FILE Markdown file to write. If nothing is provided it writes to stdout.
Create a markdown documentation from React components.
If a directory is passed, it is recursively traversed.
Contributing
First of all, thank you for wanting to help!
- Fork it.
- Create a feature branch -
git checkout -b more_magic
- Add tests and make your changes
- Check if tests are ok -
npm test
- Commit changes -
git commit -am "Added more magic"
- Push to Github -
git push origin more_magic
- Send a pull request! :heart: :sparkling_heart: :heart: