@stackbit/components

Stackbit Components Library

View the Component Library at https://components.stackbit.com/

Quickstart

• run npm install
• run npm run dev
• 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

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

• Make sure you are on the main branch
• Check that all files are committed and there are no outstanding git changes.
• 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.
• Run git push origin main --tags
• Internal Stackbit CI/CD pipeline will publish the NPM package