https://github.com/stackbit/stackbit-components

Stackbit components library
https://github.com/stackbit/stackbit-components

Last synced: 10 days ago
JSON representation

Stackbit components library

• Host: GitHub
• URL: https://github.com/stackbit/stackbit-components
• Owner: stackbit
• License: mit
• Created: 2021-06-16T16:42:50.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-12-01T20:54:33.000Z (almost 3 years ago)
• Last Synced: 2024-09-26T02:11:39.936Z (about 2 months ago)
• Language: TypeScript
• Homepage: https://components.stackbit.com
• Size: 18.2 MB
• Stars: 2
• Watchers: 5
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Stackbit Components Library

View the Component Library at [https://components.stackbit.com/](https://components.stackbit.com/)

## Quickstart

1. run `npm install`

1. run `npm run dev`

1. Navigate to http://localhost:6006/ to open Storybook

## About

This repository contains the **components** and **styles** used by Stackbit themes. It is published as an NPM module [@stackbit/components](https://www.npmjs.com/package/@stackbit/components) 

You can edit components and styles and view the changes in Storybook. 

> To use components locally with a theme without having to to publish to NPM every time use this repo: https://github.com/stackbit/stackbit-theme-utils

## Building Storybook

To build Storybook run `npm build`

## Building and Publishing Component Library

1. Make sure you are on the `main` branch

1. Check that all files are committed and there are no outstanding git changes.

1. Run `npm run version-patch` to update the patch `v0.1.0` => `v0.1.1` or run `npm run version-minor` to update the minor `v0.1.1` => `v0.2.0`. This script updates the versions of `package.json` and `package-lock.json`, commits the changes and applies a git tag with new version.

1. Run `git push origin main --tags`

1. Internal Stackbit CI/CD pipeline will publish the NPM package