Skip to content

xStad/demozap

 
 

Repository files navigation

DemoZap ⚡

npm version CI oclif semantic-release prettier TypeScript

Easily create demos of React components

Maintaining example code and demo separately makes it painful, it's easy to get them out of sync 🙅

Code can't lie, documentation can 💥

DemoZap CLI keeps your code up to date with demo 💪

Usage

  • Name component files as [component_name].demozap.jsx
  • Run npx demozap generate

Use created demos 🎉

Install

React

npm install -D react-demo-tab

Generated Demos

  • Generated demo files are prefixed with _:
    MyComponent.demozap.jsx_MyComponent.jsx
  • or set custom prefix:
    npx demozap generate --prefix=CustomPrefix

Built with DemoZap

Manually create demos

To manually create demos instead via CLI use DemoTab component.

Contributing

All contributions are welcome!

About

⚡ Create React components demos in a zap

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 76.9%
  • JavaScript 18.6%
  • SCSS 2.3%
  • CSS 1.2%
  • Other 1.0%