Switch branches/tags
Nothing to show
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
misc
src
test
CHANGELOG.md
LICENSE
README.md
package.json

README.md

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 esdoc-react-plugin

Config

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

Dependency

  • esdoc-standard-plugin

LICENSE

MIT

Author

Ryo Maruyama@h13i32maru