https://github.com/morlay/react-docgen-ui

https://github.com/morlay/react-docgen-ui

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/morlay/react-docgen-ui
• Owner: morlay
• Created: 2015-05-02T04:59:09.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2016-08-01T09:53:16.000Z (almost 10 years ago)
• Last Synced: 2025-04-15T07:18:39.502Z (about 1 year ago)
• Language: JavaScript
• Homepage: http://morlay.github.io/react-docgen-ui
• Size: 942 KB
• Stars: 17
• Watchers: 3
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
## React DocGen UI

[![Build Status](https://img.shields.io/travis/morlay/react-docgen-ui.svg?style=flat-square)](https://travis-ci.org/morlay/react-docgen-ui)

[![NPM](https://img.shields.io/npm/v/react-docgen-ui.svg?style=flat-square)](https://npmjs.org/package/react-docgen-ui)

[![Dependencies](https://img.shields.io/david/morlay/react-docgen-ui.svg?style=flat-square)](https://david-dm.org/morlay/react-docgen-ui)

[![License](https://img.shields.io/npm/l/react-docgen-ui.svg?style=flat-square)](https://npmjs.org/package/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)

```js

    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