JavaScript HTML Makefile Shell
Latest commit 4c45c03 Feb 9, 2017 @herrstucki herrstucki 2.5.3

README.md

Catalog Logo

Codeship Status for interactivethings/catalog

Catalog

Catalog lets you create beautiful living style guides with Markdown.

The standalone version is completely dependency free, making it trivial to integrate Catalog into your application.

Catalog can also be directly integrated into a React app to develop and document components.

Read Catalog's documentation (built with Catalog!) to find out more.

Installation

Standalone Builds

Prerelease Builds

npm

npm install catalog --save

react and react-dom are peerDependencies, so you need to install them separately.

Development

make

installs npm dependencies and starts the development server.

make watch-lib

builds the files from src/ into lib/ continuously. Useful with npm link when you want to test integration with another app.

make build

builds catalog.js, catalog.min.js, and lib/

make test

runs tests

Releasing

make version

prompts for a new version number.

make publish

publishes to npm and gh-pages if an unpublished version number is detected. Usually will run automatically via CI.

Credits

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