Giter VIP home page Giter VIP logo

mui-styleguidist-wrapper's Introduction

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

  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.

mui-styleguidist-wrapper's People

Contributors

lemaik avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.