https://github.com/teamwertarbyte/mui-styleguidist-wrapper
A wrapper of react-styleguidist for Material-UI components.
https://github.com/teamwertarbyte/mui-styleguidist-wrapper
Last synced: 4 months ago
JSON representation
A wrapper of react-styleguidist for Material-UI components.
- Host: GitHub
- URL: https://github.com/teamwertarbyte/mui-styleguidist-wrapper
- Owner: TeamWertarbyte
- Created: 2017-06-09T11:36:33.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-07-10T11:28:49.000Z (almost 9 years ago)
- Last Synced: 2025-03-27T02:21:30.098Z (about 1 year ago)
- Language: JavaScript
- Size: 159 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Minimal Material-UI styleguidist wrapper
This is a tiny component we use to create [React Styleguidist][styleguidist] guides for our [Material-UI] components with minimal effort.
[material-ui]: http://material-ui.com
[styleguidist]: https://react-styleguidist.js.org/
```
npm i --save-dev @wertarbyte/mui-styleguidist-wrapper
```
## Usage
1. Install the wrapper
```
npm i --save-dev @wertarbyte/mui-styleguidist-wrapper
```
2. Add the following lines to the `scripts` section of the `package.json` file:
```
"styleguide": "mui-styleguidist server",
"styleguide:build": "mui-styleguidist build"
```
3. Use `npm run styleguide` to start a styleguidist server or `npm 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.