You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+1
Original file line number
Diff line number
Diff line change
@@ -138,6 +138,7 @@ The [User Guide](https://github.com/facebookincubator/create-react-app/blob/mast
138
138
-[Generating Dynamic `<meta>` Tags on the Server](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#generating-dynamic-meta-tags-on-the-server)
139
139
-[Pre-Rendering into Static HTML Files](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#pre-rendering-into-static-html-files)
-[Developing Components in Isolation](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#developing-components-in-isolation)
141
142
-[Making a Progressive Web App](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#making-a-progressive-web-app)
-[Progressive Web App Metadata](#progressive-web-app-metadata)
@@ -1431,14 +1434,15 @@ For an example, a simple button component could have following states:
1431
1434
1432
1435
Usually, it’s hard to see these states without running a sample app or some examples.
1433
1436
1434
-
Create React App doesn’t include any tools for this by default, but you can easily add [Storybook for React](https://storybook.js.org) ([source](https://github.com/storybooks/storybook)) to your project. **It is a third-party tool that lets you develop components and see all their states in isolation from your app**.
1437
+
Create React App doesn’t include any tools for this by default, but you can easily add [Storybook for React](https://storybook.js.org) ([source](https://github.com/storybooks/storybook)) or [React Styleguidist](https://react-styleguidist.js.org/) ([source](https://github.com/styleguidist/react-styleguidist)) to your project. **These are third-party tools that let you develop components and see all their states in isolation from your app**.
1435
1438
1436
1439

1437
1440
1438
-
A storybook can also be deployed as a static app.
1439
-
This way, everyone in your team can view and review different states of UI components without starting a backend server or creating an account in your app.
1441
+
You can also deploy your Storybook or style guide as a static app. This way, everyone in your team can view and review different states of UI components without starting a backend server or creating an account in your app.
1440
1442
1441
-
### Setup your app with Storybook
1443
+
### Getting Started with Storybook
1444
+
1445
+
Storybook is a development environment for React UI components. It allows you to browse a component library, view the different states of each component, and interactively develop and test components.
1442
1446
1443
1447
First, install the following npm package globally:
1444
1448
@@ -1461,6 +1465,40 @@ Learn more about React Storybook:
*[Snapshot Testing UI](https://github.com/storybooks/storybook/tree/master/addons/storyshots) with Storybook + addon/storyshot
1463
1467
1468
+
### Getting Started with Styleguidist
1469
+
1470
+
Styleguidist combines of a style guide, where all your components are presented on a single page with their props documentation and usage examples, with an environment for developing components in isolation, similar to Storybook. In Styleguidist you write examples in Markdown, where each code snippet is rendered as a live editable playground.
1471
+
1472
+
First install Styleguidist and peer dependencies from npm:
1473
+
1474
+
```sh
1475
+
npm install --save-dev react-styleguidist webpack
1476
+
```
1477
+
1478
+
Then, add these scripts to your `package.json`:
1479
+
1480
+
```sh
1481
+
{
1482
+
"scripts": {
1483
+
"styleguide": "styleguidist server",
1484
+
"styleguide:build": "styleguidist build"
1485
+
}
1486
+
}
1487
+
```
1488
+
1489
+
Then, run the following command inside your app’s directory:
1490
+
1491
+
```sh
1492
+
npm run styleguide
1493
+
```
1494
+
1495
+
After that, follow the instructions on the screen.
0 commit comments