@shadow-ui/storybook-theme

A standardized theme for ShadowUI Storybook environments.

Usage no npm install needed!

<script type="module">
  import shadowUiStorybookTheme from 'https://cdn.skypack.dev/@shadow-ui/storybook-theme';
</script>

README

@inspire11/storybook-theme

Version Downloads Build License

๐Ÿ“ฆ @inspire11/storybook-theme

This package is a standardized branding-compliant theme for Inspire11 Storybook projects.

  1. ๐Ÿ’ผ Getting Started 1.1 ๐Ÿ“š Prerequisites 1.2 ๐Ÿ“ฒ Installing
  2. ๐Ÿ›  Testing 2.1 ๐Ÿ” E2E 2.2 ๐Ÿ› Static Analysis
  3. ๐Ÿ›ฅ Deployment
  4. ๐Ÿงพ Important Dependencies
  5. ๐Ÿ™Œ๐Ÿผ Contributing
  6. ๐Ÿท Versioning
  7. ๐Ÿ“œ Authors
  8. ๐Ÿ“„ License
  9. ๐Ÿ“ฏ Acknowledgments

๐Ÿ’ผ Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

๐Ÿ“š Prerequisites

What things you need to install the software and how to install them

Give examples

๐Ÿ“ฒ Installing

To install the package, clone and build the repo, then use npm to install dependencies.

git clone git@bitbucket.org:inspire11/banners.git
cd banners
npm i

๐Ÿ›ฅ Deployment

To push changes to the theme, update the package version and publish to NPM:

git version patch
npm publish --access=public

๐Ÿ™Œ๐Ÿผ Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

๐Ÿท Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

๐Ÿ“œ Authors

See also the list of contributors who participated in this project.

๐Ÿ“„ License

This project is licensed under the MIT License - see the LICENSE.md file for details.