open-index/open-npm huggingface dataset:
npm package: @nordddb/catalog
Description: Create living style guides using Markdown or React
Latest version: 4.4.8

# This is a fork of Catalog

Main repository is available here: https://github.com/interactivethings/catalog

## Installation

```sh
yarn add @nordddb/catalog
```

## Create a new release and push it to npm

Run these commands to generate a new release and push it to npm

```
make test
make build
make version
git push && git push --tags
make publish
```

# 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.