Getting started with React Styleguidist

1. Install Styleguidist

Install webpack if you don’t have it already and aren’t using Create React App:

npm install --save-dev webpack

Install Styleguidist:

npm install --save-dev react-styleguidist

2. Configure your style guide

If you’re using Create React App you can skip this step.

• Point Styleguidist to your React components
• Tell Styleguidist how to load your app’s code

3. Start your style guide

• Run npx styleguidist server to start a style guide dev server.
• Run npx styleguidist build to build a production HTML version.

tip

We recommend adding these commands to your package.json.

4. Start documenting your components

See how to document your components.

Something isn’t working?

• Solutions for common problems and questions
• Configuring Styleguidist with third-party tools