@wertarbyte/mui-styleguidist-wrapper
v0.1.3
Published
A wrapper of react-styleguidist for Material-UI components.
Downloads
9
Readme
Minimal Material-UI styleguidist wrapper
This is a tiny component we use to create React Styleguidist guides for our Material-UI components with minimal effort.
npm i --save-dev @wertarbyte/mui-styleguidist-wrapper
Usage
- Install the wrapper
npm i --save-dev @wertarbyte/mui-styleguidist-wrapper
- Add the following lines to the
scripts
section of thepackage.json
file:"styleguide": "mui-styleguidist server", "styleguide:build": "mui-styleguidist build"
- Use
npm run styleguide
to start a styleguidist server ornpm run styleguide:build
to build the styleguide.
The commands must be run from the project's root dir.
You can customize the styleguide config by adding a styleguide.config.js
file to the project's root dir. This file will be extended with our default values.