https://github.com/TwoStoryRobot/storybook-addon-docgen

Generates documentation using react-docgen
https://github.com/TwoStoryRobot/storybook-addon-docgen

Last synced: 1 day ago
JSON representation

Generates documentation using react-docgen

• Host: GitHub
• URL: https://github.com/TwoStoryRobot/storybook-addon-docgen
• Owner: TwoStoryRobot
• License: mit
• Archived: true
• Created: 2018-01-25T19:53:37.000Z (almost 7 years ago)
• Default Branch: dev
• Last Pushed: 2019-02-07T18:07:30.000Z (almost 6 years ago)
• Last Synced: 2024-09-10T11:02:15.492Z (2 months ago)
• Language: JavaScript
• Size: 870 KB
• Stars: 4
• Watchers: 5
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-designops - Docgen addon - generates documenation for Storybook using React docgen. (Design System Tools / Components)

README

        

[![Build Status](https://semaphoreci.com/api/v1/twostoryrobot/storybook-addon-docgen/branches/master/shields_badge.svg)](https://semaphoreci.com/twostoryrobot/storybook-addon-docgen)

[![npm (scoped)](https://img.shields.io/npm/v/@twostoryrobot/storybook-addon-docgen.svg)](https://www.npmjs.com/package/@twostoryrobot/storybook-addon-docgen)

# storybook-addon-docgen

Generates documentation using react-docgen

## Development

```bash

# Fork this repo and git clone it

npm install

npm run storybook

```

## Usage

Add the addon to your `.storybook/addons.js`

```javascript

import '@twostoryrobot/storybook-addon-docgen/register'

```

Add the `docgen` decorator to your stories. You must supply the component you

want the documentation from. In this case we want to docs supplied from the

Button component.

```jsx

import docgen from '@twostoryrobot/storybook-addon-docgen'

storiesOf('Button', module)

  .addDecorator(docgen(Button))

  .add('with text', () => (

    Hello Button

  ))

```