Package Exports

@itsjamie/esdoc-react-plugin
@itsjamie/esdoc-react-plugin/src/Plugin.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@itsjamie/esdoc-react-plugin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ESDoc React Plugin (PoC)

This plugin is proof of concept. So, the plugin has only minimum features. We are waiting for your pull request!

Example

/**
 * This is MyClass.
 * @reactProps {!number} prop1 - this is prop1
 * @reactProps {string} prop2 - this is prop2
 */
export default class MyClass extends React.Component {
}

Install

npm install @itsjamie/esdoc-react-plugin

Config

{
  "source": "./src",
  "destination": "./doc",
  "plugins": [
    {"name": "@itsjamie/esdoc-standard-plugin"},
    {"name": "@itsjamie/esdoc-react-plugin"}
  ]
}

Dependency

esdoc-standard-plugin

LICENSE

MIT

Author

Ryo Maruyama@h13i32maru