{"id":13431881,"url":"https://github.com/interactivethings/catalog","last_synced_at":"2025-05-14T21:08:45.530Z","repository":{"id":19025570,"uuid":"22249306","full_name":"interactivethings/catalog","owner":"interactivethings","description":"Create living style guides using Markdown or React","archived":false,"fork":false,"pushed_at":"2023-01-03T22:27:14.000Z","size":18861,"stargazers_count":1603,"open_issues_count":114,"forks_count":145,"subscribers_count":28,"default_branch":"v4","last_synced_at":"2025-05-14T11:50:00.066Z","etag":null,"topics":["catalog","docs","documentation","documentation-tool","markdown","react","style-guide","styleguide"],"latest_commit_sha":null,"homepage":"https://www.catalog.style/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/interactivethings.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-07-25T07:53:56.000Z","updated_at":"2025-05-13T01:35:56.000Z","dependencies_parsed_at":"2023-01-14T07:45:43.394Z","dependency_job_id":null,"html_url":"https://github.com/interactivethings/catalog","commit_stats":null,"previous_names":[],"tags_count":175,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interactivethings%2Fcatalog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interactivethings%2Fcatalog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interactivethings%2Fcatalog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interactivethings%2Fcatalog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/interactivethings","download_url":"https://codeload.github.com/interactivethings/catalog/tar.gz/refs/heads/v4","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254161403,"owners_count":22024751,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["catalog","docs","documentation","documentation-tool","markdown","react","style-guide","styleguide"],"created_at":"2024-07-31T02:01:06.714Z","updated_at":"2025-05-14T21:08:40.517Z","avatar_url":"https://github.com/interactivethings.png","language":"JavaScript","readme":"![Catalog Logo](https://interactivethings.github.io/catalog/docs/assets/catalog_logo.svg)\n\n[![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)]()\n\n\u003e 🚧 This is the currently in-development v4 branch. Stable code is in [master](https://github.com/interactivethings/catalog/tree/master).\n\n# Catalog\n\nCatalog lets you create beautiful living and fully interactive style guides using Markdown and React components.\n\nPlease read the [Catalog documentation](https://docs.catalog.style/) (built with Catalog!) for detailed installation and usage instructions.\n\n## Installation\n\n### yarn\n\n```\nyarn add catalog react react-dom\n```\n\n### npm\n\n```\nnpm install catalog react react-dom --save\n```\n\n## Development\n\n\u003e Please make sure that you have Node \u003e= 6 and [yarn](https://yarnpkg.com/) installed.\n\n### Build process\n\nStart the build process in watch mode:\n\n```\nmake\n```\n\n### Docs\n\nTo edit Catalog documentation, run:\n\n```\nmake docs\n```\n\n\u003e Note: this uses the local Catalog build from `dist/`. Run `make` before/alongside `make docs`.\n\n### Linking\n\nWhen developing Catalog you want to link it locally:\n\n```\nyarn link\n```\n\nYou can then link to this version in your project (or one of the examples):\n\n```\nyarn link catalog\n```\n\n### Tests\n\nTo run [Jest](https://facebook.github.io/jest/) tests in watch mode:\n\n```\nmake test-watch\n```\n\n## Creating a Release\n\nBump Catalog's version:\n\n```\nmake version\n```\n\nThen push including tags:\n\n```\ngit push \u0026\u0026 git push --tags\n```\n\nThe CI server will automatically run tests, build and publish the new version to npm\n\n## CI commands\n\n\u003e These usually run automatically on the CI server\n\n### Create a build\n\n```\nmake build\n```\n\n### Create a documentation build\n\n```\nmake build-docs\n```\n\n### Publish to npm and generate GitHub release notes\n\n```\nmake publish\n```\n\n## Credits\n\nCatalog 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.\n","funding_links":[],"categories":["JavaScript","documentation"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finteractivethings%2Fcatalog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finteractivethings%2Fcatalog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finteractivethings%2Fcatalog/lists"}