Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marborkowski/react-doc-generator
Generate a simple React component documentation in Markdown.
https://github.com/marborkowski/react-doc-generator
Last synced: about 2 months ago
JSON representation
Generate a simple React component documentation in Markdown.
- Host: GitHub
- URL: https://github.com/marborkowski/react-doc-generator
- Owner: marborkowski
- License: mit
- Created: 2017-03-02T19:50:54.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T19:56:59.000Z (over 1 year ago)
- Last Synced: 2024-04-25T09:22:46.334Z (5 months ago)
- Language: JavaScript
- Homepage:
- Size: 527 KB
- Stars: 54
- Watchers: 3
- Forks: 30
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# React DOC Generator
[](https://www.npmjs.com/package/react-doc-generator)
[](https://david-dm.org/marborkowski/react-doc-generator)
[](https://travis-ci.org/marborkowski/react-doc-generator)
Generate simple React components documentation in [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet).
## Installation
`$ npm install -save-dev react-doc-generator`
## Usage
Check every option runnig `react-doc-generator` with `--help` or `-h`:
```
$ react-doc-generator --help
Usage: react-doc-generator [options]
Options:
-h, --help output usage information
-V, --version output the version number
-x, --extensions Include only these file extensions. Default: js,jsx
-i, --ignore Folders to ignore. Default: node_modules,__tests__,__mocks__
-e, --exclude-patterns Filename patterns to exclude. Default: []
-t, --title [value]> Document title. Default: 'Components'
-o, --output Markdown file to write. Default: 'README.MD'
```
### By the command line
Example:
`$ react-doc-generator src -o DOCUMENTATION.md`
### NPM script
Example:
In your `package.json` put:
```
{
// ...
"scripts": {
"doc": "react-doc-generator ./app/components/custom -o DOCUMENTATION.md"
}
// ...
}
```
so then you are able to call this script by the command line:
`$ npm run doc`
## API
```js
/**
* General component description.
* You can even use the native Markdown here.
* E.g.:
* ```html
*
* ```
*/
export class MyComponent extends React.Component {
static displayName = 'Official Component Name'
static propTypes = {
/**
* Description of prop "foo".
*/
foo: React.PropTypes.number,
/**
* Description of prop "bar" (a custom validation function).
*/
bar: function(props, propName, componentName) {
// ...
},
baz: React.PropTypes.oneOfType([
React.PropTypes.number,
React.PropTypes.string
]),
}
static defaultProps = {
foo: 10000099999
}
render () {
return (
Hello);
}
}
```
Because [**react-doc-generator**](https://github.com/marborkowski/react-doc-generator) uses [**react-docgen**](https://github.com/reactjs/react-docgen) library, you can [follow other examples here](https://github.com/reactjs/react-docgen).
## Demo
* [Example output](https://github.com/marborkowski/react-doc-generator/blob/master/demo/DOCUMENTATION.md)
## Terminal
This is an example of what you'll see in your terminal.
### License
MIT License
Copyright (c) 2017 Marcin Borkowski ()
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.