Create living style guides using Markdown or React
Clone or download
Latest commit 8b4698e Oct 8, 2018
Permalink
Failed to load latest commit information.
.vscode Use Prettier πŸ’… (#393) Mar 27, 2018
cli Use Prettier πŸ’… (#393) Mar 27, 2018
docs Typesetting improvements (#446) Oct 8, 2018
examples Add Babel Standalone to docs and example Aug 23, 2018
flow-typed/npm Upgrade flow and flow-typed Feb 27, 2018
scripts Add `release` tool to publishing workflow Dec 11, 2017
src Typesetting improvements (#446) Oct 8, 2018
types/catalog pageLoader() accepts any promise that returns a React ComponentType Sep 13, 2018
.babelrc Replace Radium with Emotion πŸ‘©β€πŸŽ€ (#394) Mar 29, 2018
.eslintrc.json Upgrade app and build depencendies (#412) Apr 27, 2018
.flowconfig Upgrade dependencies (#291) May 22, 2017
.gitignore Migrate docs (#380) Feb 27, 2018
.npmrc-template Move .npmrc out of the way, only use while publishing May 4, 2016
.prettierignore Use Prettier πŸ’… (#393) Mar 27, 2018
.travis.yml 3.0.0-rc.4 Aug 23, 2017
AUTHORS Update Designers Sep 21, 2017
CHANGELOG.md Fix typos (#344) Dec 16, 2017
LICENSE Update license year May 22, 2016
Makefile TypeScript declaration file (#383) Mar 14, 2018
README.md Migrate docs (#380) Feb 27, 2018
babel.js Use Prettier πŸ’… (#393) Mar 27, 2018
deploy-key.enc Add Travis deploy key and npm token Mar 7, 2017
loader.js Use Prettier πŸ’… (#393) Mar 27, 2018
package.json 3.6.0 Oct 8, 2018
rollup.config.lib.js Enable source maps in lib builds Apr 7, 2018
rollup.config.standalone.js Upgrade rollup (#438) Jul 17, 2018
yarn.lock Typesetting improvements (#446) Oct 8, 2018

README.md

Catalog Logo

Travis Downloads Version License

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.