| 1 | # react-docgen loader for webpack
|
| 2 |
|
| 3 | ## Usage
|
| 4 |
|
| 5 | ``` javascript
|
| 6 | var docs = require("!!docgen!./Component.jsx");
|
| 7 | // => returns Component.jsx documentation object if Component definition is found
|
| 8 | ```
|
| 9 |
|
| 10 | ### Markdown description
|
| 11 |
|
| 12 | If the description is in markdown you can parse it with `marked` by adding a query
|
| 13 |
|
| 14 | ``` javascript
|
| 15 | var docs = require("!!docgen?markdownDescription!./Component.jsx");
|
| 16 | ```
|
| 17 |
|
| 18 | > NOTE: I use double !! to disable all other loaders. react-docgen cannot gather Component information if the Component has been babeled
|
| 19 |
|
| 20 | ## License
|
| 21 |
|
| 22 | MIT (http://www.opensource.org/licenses/mit-license.php)
|