🚧This is the currently in-development v4 branch. Stable code is in master.
Catalog lets you create beautiful living and fully interactive style guides using Markdown and React components.
Please read the Catalog documentation (built with Catalog!) for detailed installation and usage instructions.
yarn add catalog react react-dom
npm install catalog react react-dom --save
Please make sure that you have Node >= 6 and yarn installed.
Start the build process in watch mode:
To edit Catalog documentation, run:
Note: this uses the local Catalog build from
When developing Catalog you want to link it locally:
You can then link to this version in your project (or one of the examples):
yarn link catalog
To run Jest tests in watch mode:
Creating a Release
Bump Catalog's version:
Then push including tags:
git push && git push --tags
The CI server will automatically run tests, build and publish the new version to npm
These usually run automatically on the CI server
Create a build
Create a documentation build
Publish to npm and generate GitHub release notes