@digitalstudio/play

An unopiated styleguide engine for react. **`play`** does the plumbing **`you`** do the styling!

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@digitalstudio/play
Minified + gzip package size for @digitalstudio/play in KB

Readme

⛳ play

An unopiated styleguide engine for react. play does the plumbing you do the styling!

Features

  • Authoring documentation un markdown (mdx)
  • Props definition extraction
  • Live code editing
  • Great development environement with live reload, error overlays and more... (powered by create-react-app)

Usage

npm install @digitalstudio/play --save-dev
play init # setup the minimal file structure
play # runs your styleguide server
play build # build static assets

Dev

when changing files in src, dont forget to run npm run build-dist

Inspiration

https://www.docz.site/ https://www.catalog.style/ https://react-styleguidist.js.org/examples/basic/ https://styleguide.auth0.com/#/ http://styleguides.io/

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.