interviewstreet / hr-docgen-loader-deprecated

Small loader converting Component definition to react-docgen documentation

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

react-docgen loader for webpack

Usage

var docs = require("!!docgen!./Component.jsx");
// => returns Component.jsx documentation object if Component definition is found

Markdown description

If the description is in markdown you can parse it with marked by adding a query

var docs = require("!!docgen?markdownDescription!./Component.jsx");

NOTE: I use double !! to disable all other loaders. react-docgen cannot gather Component information if the Component has been babeled

License

MIT (http://www.opensource.org/licenses/mit-license.php)

About

Small loader converting Component definition to react-docgen documentation


Languages

Language:JavaScript 100.0%