react-demo-tab-cli

React DemoTab CLI 📑

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 💥

DemoTab CLI keeps your code up to date with demo 💪

Install

npm install -D react-demo-tab react-demo-tab-cli

Demo

DemoTab example

Usage 🚀

To use CLI in your project:

1. default export react components that you wish to create demos of
2. name component file as [filename].demotab.jsx
3. run $ npx react-demo-tab-cli generate

Use created demos 🎉

Generated Demos

• By default generated demo files will be prefixed with _ for example:
  MyComponent.demotab.jsx & MyComponent.demotab.css -> _MyComponent.jsx
• You can set custom prefix with --prefix flag:
  $ demotab generate --prefix=CustomPrefix

Built with DemoTab

• React Tilt - Repo - DemoTab
• Mighty Mouse - Repo - DemoTab
• Magnetic Board - Repo - DemoTab

Manually create demos

If you wish to manually create demos instead via CLI, see React DemoTab.

License

MIT