react-cosmos-docs-proxy
v1.0.0
Published
A React Cosmos proxy for showing component docs using react-docgen
Downloads
4
Maintainers
Readme
react-docs-cosmos-proxy
A react-cosmos plugin to show component documentation generated using react-docgen.
Usage
Follow the react-cosmos instructions before setting this up.
The recommended way to get the component docs is to use
babel-plugin-react-docgen
and include it in your .babelrc
:
{
plugins: ['react-docgen']
}
Then just add the proxy to cosmos.proxies.js
:
import createDocsProxy from 'react-cosmos-docs-proxy';
export default [
createDocsProxy()
];