hhy5277 / catalog

Create living style guides using Markdown or React

🚧 This is the currently in-development v4 branch. Stable code is in master.

Catalog

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.

Installation

yarn

yarn add catalog react react-dom

npm

npm install catalog react react-dom --save

Development

Please make sure that you have Node >= 6 and yarn installed.

Build process

Start the build process in watch mode:

make

Docs

To edit Catalog documentation, run:

make docs

Note: this uses the local Catalog build from dist/. Run make before/alongside make docs.

Linking

When developing Catalog you want to link it locally:

yarn link

You can then link to this version in your project (or one of the examples):

yarn link catalog

Tests

To run Jest tests in watch mode:

make test-watch

Creating a Release

Bump Catalog's version:

make 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

CI commands

These usually run automatically on the CI server

Create a build

make build

Create a documentation build

make build-docs

Publish to npm and generate GitHub release notes

make publish

Credits

Catalog is developed by many people at Interactive Things, a User Experience and Data Visualization Studio based in Zürich.