nicholas-b-carter / react-docgen-ui Goto Github PK

React DocGen UI

How to use

use gulp to generate react-doc.json (react-doc infos with examples) and react-doc.js (requires in all example)

    gulp.src([
      'path/to/components/which/need/to/generate/docs'
    ])
      .pipe(gulpDocGenUi({
        cwd: gutil.env.cwd ? process.cwd() : null
      }))
      .on('error', gutil.log.bind(gulp))
      .pipe(gulp.dest(`path/to/dist`))

then see the example to config and create the doc pages.

## Options

### descriptionCompiler

Pass descriptionCompiler: str => str to change the default compiler marked on description keys in the exported object. This is useful if you want to process the docs further yourself, for example building full markdown documentation pages.

Change logs

• 0.4.x updated to babel6, if use commonjs, notice the default issue