https://github.com/mitchgavan/react-mdx-styleguide

A custom style guide/design system/component library for React apps.
https://github.com/mitchgavan/react-mdx-styleguide

component-library css-in-js design-system mdx react styleguide

Last synced: 3 days ago
JSON representation

A custom style guide/design system/component library for React apps.

• Host: GitHub
• URL: https://github.com/mitchgavan/react-mdx-styleguide
• Owner: mitchgavan
• Created: 2020-04-22T07:49:50.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T22:43:35.000Z (almost 2 years ago)
• Last Synced: 2024-04-15T00:16:47.592Z (7 months ago)
• Topics: component-library, css-in-js, design-system, mdx, react, styleguide
• Language: TypeScript
• Homepage:
• Size: 779 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# React MDX Style Guide

A custom style guide/design system/component library. It can be completely customised for your React application. It includes the features you've come to expect with a modern style guide, including;

- Component pages that are live editable.

- Custom syntax highlighting.

- Auto documentation of your components' props.

## Getting Started

In the project directory, first run `npm install`, then you can run:

### `npm start`

Runs the app in the development mode.

Open [http://localhost:8080](http://localhost:8080) to view it in the browser.

The page will reload if you make edits.

### `npm test`

Launches the test runner in the interactive watch mode.

### `npm run build`

Builds the app for production to the `build` folder.