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
dist/
. Runmake
before/alongsidemake docs
.
When developing Catalog you want to link it locally:
You can then link to this version in your project (or one of the examples):
To run Jest tests in watch mode:
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
Create a documentation build Publish to npm and generate GitHub release notesThese usually run automatically on the CI server
Catalog is developed by many people at Interactive Things, a User Experience and Data Visualization Studio based in Zürich.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4