{"id":17072308,"url":"https://github.com/malcolm-kee/react-showroom","last_synced_at":"2025-04-12T19:53:23.226Z","repository":{"id":37697254,"uuid":"401102038","full_name":"malcolm-kee/react-showroom","owner":"malcolm-kee","description":"Document React components by declaring props definition and writing markdown.","archived":false,"fork":false,"pushed_at":"2023-11-11T03:46:39.000Z","size":2247,"stargazers_count":44,"open_issues_count":9,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-12T19:53:14.077Z","etag":null,"topics":["component-library","react","showroom","typescript"],"latest_commit_sha":null,"homepage":"https://react-showroom.js.org/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/malcolm-kee.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-29T17:29:48.000Z","updated_at":"2024-10-29T16:54:35.000Z","dependencies_parsed_at":"2024-06-21T03:55:51.009Z","dependency_job_id":"79037742-7652-4f59-a519-f3fd675e6b98","html_url":"https://github.com/malcolm-kee/react-showroom","commit_stats":{"total_commits":273,"total_committers":2,"mean_commits":136.5,"dds":0.0073260073260073,"last_synced_commit":"69135dab70bff98995f0bab1d09bc48213d4756a"},"previous_names":[],"tags_count":69,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/malcolm-kee%2Freact-showroom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/malcolm-kee%2Freact-showroom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/malcolm-kee%2Freact-showroom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/malcolm-kee%2Freact-showroom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/malcolm-kee","download_url":"https://codeload.github.com/malcolm-kee/react-showroom/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248625509,"owners_count":21135513,"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":["component-library","react","showroom","typescript"],"created_at":"2024-10-14T11:39:28.953Z","updated_at":"2025-04-12T19:53:23.209Z","avatar_url":"https://github.com/malcolm-kee.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# react-showroom\n\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n\n\u003cdiv style=\"text-align:center;\"\u003e\n    \n![React Showroom](docs/assets/react-showroom.png)\n\n\u003c/div\u003e\n\n[![npm version](https://badge.fury.io/js/react-showroom.svg)](https://badge.fury.io/js/react-showroom)\n\nhttps://react-showroom.js.org/\n\nDocument React components by declaring props definition and writing markdown.\n\n## Key Features\n\n- Auto generate documentations for your component props from the component's TypeScript definition.\n- Write markdown to show examples to use the component, which will become an editable playground.\n- Auto generated props control/knobs based on component props type definitions.\n- Supported languages for live examples: typescript (TSX and TS), javascript (JSX and JS), and HTML.\n- Improve collaborations: edit code/add comments on specific examples with shareable URL without any backend.\n- Ensure the components are SSR-friendly - the site can be pre-render on build time.\n\n## Built With\n\n- [webpack](https://webpack.js.org/)\n- [esbuild](https://esbuild.github.io/)\n- [react-docgen-typescript](https://www.npmjs.com/package/react-docgen-typescript)\n- [Stitches](https://stitches.dev/)\n- [Radix Primitives](https://www.radix-ui.com/)\n- [xdm](https://github.com/wooorm/xdm)\n\n## Inspired by\n\nThis project is largely inspired by [React Styleguidist](https://react-styleguidist.js.org/). To be honest this project was started as my plan to rewrite it to understand how it works.\n\nThe standalone editor view is inspired by [Playroom](https://github.com/seek-oss/playroom).\n\n## Philosophy\n\nThe philosophy of React Showroom is that you should be continuing your existing workflow (declaring component props/writing standard markdown) and the Showroom is just an automatic side product (hopefully a valuable one) of that workflow.\n\nThis is in contrast with [Storybook](https://storybook.js.org/) where it aims to be central part of your development workflow (and requires you to write examples/documentations in a special format).\n\nWe believe that compared to languages (TypeScript and markdown), libraries are generally short-lived and often less stable. Write your documentations in a more stable medium gives you more freedom and allows you to migrate to alternative tool in future.\n\n## Roadmap\n\nFollowing are the ideas that I want to implement as enhancements (but I not sure if they are possible):\n\n- Run jest tests in the Showroom\n- Vue support\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://malcolmkee.com\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/24528512?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eMalcolm Kee\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/malcolm-kee/react-showroom/commits?author=malcolm-kee\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/malcolm-kee/react-showroom/issues?q=author%3Amalcolm-kee\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmalcolm-kee%2Freact-showroom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmalcolm-kee%2Freact-showroom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmalcolm-kee%2Freact-showroom/lists"}