react-docify

A tool to generate markdown documentation from React source code.

Installation

$ npm install --save react-docify

Usage

const docify = require('react-docify');
docify(content); // => result

Like this sample:

'use strict';
const React = require('react');
/**
 * class description
 */
class Component extends React.Component {
  /**
   * Description of propTypes
   */
  static propTypes = {
    /**
     * Description of optionalNumber.
     */
    optionalNumber: React.PropTypes.number
  }
  /**
   * Description of displayName
   */
  static displayName = 'Component'
  /**
   * Description of defaultProps
   */
  static defaultProps = {
    optionalNumber: 123
  }
  /**
   * Description of someStaticProps
   */
  static someStaticProps = 'asdf'
  /**
   * constructor description
   */
  constructor() {
    super();
  }
  /**
   * handle event description
   */
  _handleEvent() {}
  /**
   * get value description
   */
  getValue() {

  }
  /**
   * set value description
   */
  setValue(value, config) {

  }
  /**
   * render description
   */
  render() {
    return (
      <div></div>
    );
  }
}
module.exports = Component;

And the output should be like this:

## Dependencies

* react


## Class::Component

Display Name: Component

### Methods

* getValue(): get value description
* setValue(value, config): set value description

### Class Properties

| Name | Description | Static | Value |
| :--- | :----- | :--: | :--- |
| someStaticProps | Description of someStaticProps | √ | 'asdf' |

### PropTypes

| Name | Description | Type | Required | Default Value |
| :--- | :----- | :--- | :---: | :---: |
| optionalNumber | Description of optionalNumber. | Number | × | `123` |

Configurations

template::String

Lodash template to generate the documentation from code describe object

The default value is:

## Dependencies
<% _.forEach(dependencies || [], function(dep) { %>
* <%= dep %><%  }); %>
<% _.forEach(classes || [], function(cla) { %>

## Class::<%= cla.name %>

Display Name: <%= cla.displayName %>

### Methods
<% _.forEach(cla.methods, function(method) { %>
* <%= method.name %>(<%= method.params.join(', ') %>): <%= method.description %><% }); %>

### Class Properties

<%= cla.propertiesTable %>

### PropTypes

<%= cla.propTypesTable %>

<% }); %>

And the code describe object is generated by react-docer

excludeProperties::ArrayOf(String)

Rules which properties should be exclude while generating the documentation

The default value is:

[
  'propTypes',
  'defaultProps',
  'displayName',
  /^_/
]

This means that propTypes, defaultProps, displayName and properties which name starts with _ will be excluded.

excludeMethods::ArrayOf(String)

Rules which methods should be exclude while generating the documentation

The default value is:

[
  'constructor',
  'render',
  'componentWillMount',
  'componentDidMount',
  'componentWillReceiveProps',
  'shouldComponentUpdate',
  'componentWillUpdate',
  'componentDidUpdate',
  'componentWillUnmount',
  /^_/
]

propTypesHeaders::ArrayOf(Object)

The header configurations of propTypes table

The default value is:

[{
  name: 'name',
  align: ':---',
  title: 'Name'
}, {
  name: 'description',
  align: ':-----',
  title: 'Description'
}, {
  name: 'type',
  align: ':---',
  title: 'Type'
}, {
  name: 'required',
  align: ':---:',
  title: 'Required'
}, {
  name: 'defaultValue',
  align: ':---:',
  title: 'Default Value'
}]

propertiesHeaders::ArrayOf(Object)

The header configurations of properties table

The default value is:

[{
  name: 'name',
  align: ':---',
  title: 'Name'
}, {
  name: 'description',
  align: ':-----',
  title: 'Description'
}, {
  name: 'static',
  align: ':--:',
  title: 'Static'
}, {
  name: 'value',
  align: ':---',
  title: 'Value'
}]

beforeHook::Function

Function which can be use to change the code describe object before generating the documentation

The default value is: obj => {}

Develop

$ npm run test
$ npm run build
$ npm run dev

License

The MIT License (MIT)

Copyright (c) 2015 LingyuCoder

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.