Create living style guides using Markdown or React Sample in 2020

Create living style guides using Markdown or React Sample in 2020

tutorials -


Catalog lets you create beautiful living and fully interactive style guides using Markdown and React components.



yarn add catalog react react-dom


npm install catalog react react-dom --save


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

Build process

Start the build process in watch mode:



To edit Catalog documentation, run:

make docs

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


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


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


Trending On Tutorial Stuff

Our Sponsors

Top Applications in Tutorial Stuff

Top Experts In Tutorial Stuff