https://github.com/nighttrax/react-docs-cosmos-proxy

A React Cosmos proxy for showing component docs using react-docgen
https://github.com/nighttrax/react-docs-cosmos-proxy

Last synced: 16 days ago
JSON representation

A React Cosmos proxy for showing component docs using react-docgen

• Host: GitHub
• URL: https://github.com/nighttrax/react-docs-cosmos-proxy
• Owner: NiGhTTraX
• License: mit
• Created: 2017-11-07T12:09:35.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-05-20T09:06:17.000Z (over 7 years ago)
• Last Synced: 2025-08-28T06:40:49.331Z (about 1 month ago)
• Language: JavaScript
• Size: 319 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
react-docs-cosmos-proxy

======

[![Build Status](https://travis-ci.org/NiGhTTraX/react-docs-cosmos-proxy.svg?branch=master)](https://travis-ci.org/NiGhTTraX/react-cosmos-docs-proxy)

----

![react-cosmos](./tests/acceptance/screenshots/chrome/acceptance_one-prop base.png)

A [react-cosmos](https://github.com/react-cosmos/react-cosmos) plugin to show

component documentation generated using

[react-docgen](https://github.com/reactjs/react-docgen).

## Usage

Follow the [react-cosmos](https://github.com/react-cosmos/react-cosmos#getting-started)

instructions before setting this up.

The recommended way to get the component docs is to use

[babel-plugin-react-docgen](https://github.com/storybooks/babel-plugin-react-docgen)

and include it in your `.babelrc`:

```

{

  plugins: ['react-docgen']

}

```

Then just add the proxy to `cosmos.proxies.js`:

```js

import createDocsProxy from 'react-cosmos-docs-proxy';

export default [

  createDocsProxy()

];

```