https://github.com/interactivethings/catalog

Create living style guides using Markdown or React
https://github.com/interactivethings/catalog

catalog docs documentation documentation-tool markdown react style-guide styleguide

Last synced: 2 days ago
JSON representation

Create living style guides using Markdown or React

• Host: GitHub
• URL: https://github.com/interactivethings/catalog
• Owner: interactivethings
• License: bsd-3-clause
• Created: 2014-07-25T07:53:56.000Z (over 10 years ago)
• Default Branch: v4
• Last Pushed: 2023-01-03T22:27:14.000Z (about 2 years ago)
• Last Synced: 2024-10-29T15:34:21.931Z (3 months ago)
• Topics: catalog, docs, documentation, documentation-tool, markdown, react, style-guide, styleguide
• Language: JavaScript
• Homepage: https://www.catalog.style/
• Size: 18 MB
• Stars: 1,595
• Watchers: 29
• Forks: 145
• Open Issues: 115
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - catalog - Create living style guides using Markdown or React (JavaScript)
• awesome-starred - interactivethings/catalog - Create living style guides using Markdown or React (documentation)

README

        
![Catalog Logo](https://interactivethings.github.io/catalog/docs/assets/catalog_logo.svg)

[![Travis](https://img.shields.io/travis/interactivethings/catalog.svg)](https://travis-ci.org/interactivethings/catalog/) [![Downloads](https://img.shields.io/npm/dm/catalog.svg)](https://www.npmjs.com/package/catalog) [![Version](https://img.shields.io/npm/v/catalog.svg)](https://www.npmjs.com/package/catalog) [![License](https://img.shields.io/npm/l/catalog.svg)]()

> 🚧 This is the currently in-development v4 branch. Stable code is in [master](https://github.com/interactivethings/catalog/tree/master).

# Catalog

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

Please read the [Catalog documentation](https://docs.catalog.style/) (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](https://yarnpkg.com/) 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](https://facebook.github.io/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](https://github.com/interactivethings/catalog/blob/master/AUTHORS) at [Interactive Things](https://www.interactivethings.com/), a User Experience and Data Visualization Studio based in Zürich.