au-re / react-exhibit

If you need a way to bootstrap component libraries checkout `generator-react-exhibit` instead.

DEPRECATED - generator-react-exhibit will no longer use this library and this repository won't receive further development. Over the past year I've learned much about react and I came accross a wide variety of (much better) tools and libraries to visualize and document components. I would highly recommend anyone interested in creating their own react component library to check them out instead of this repository.

In particular: storybook - it works across frameworks, comes with many plugins that you can use to create great documentation. The next version of generator-react-exhibit will come with storybook included: you can use it to bootstrap new libraries, learn more here.

react-exhibit

React components for documentation. Here to help visualize your React library. Used in generator-react-exhibit.

Using the components

In your React project run:

npm i -S react-exhibit

Import the components you want from "react-exhibit".

import React from "react";
import { Icon } from "react-exhibit";
import "../node_modules/react-exhibit/lib/css/main.css";

export default () => (<Icon />);

You can view the documentation for this library here.

react-exhibit's Issues

Add github corner (http://tholman.com/github-corners/)

Add collapsable sidebar

Add search bar