Skip to content

Commit

Permalink
Merge pull request #26178 from storybookjs/docs_fix_visual_testing_ex…
Browse files Browse the repository at this point in the history
…ample

Docs: Fix Visual tests
  • Loading branch information
jonniebigodes authored Feb 23, 2024
2 parents 68d48ea + 29793b3 commit e5cb586
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/writing-tests/visual-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,17 +50,17 @@ Select a project from your project list to finish setup. If you're setting up th

### Configure

The addon includes configuration options covering most use cases by default. You can also fine-tune the addon configuration to match your project's requirements via the [`./chromatic.config.json`](https://www.chromatic.com/docs/cli#configuration) file. Below are the available options and examples of how to use them.
The addon includes configuration options covering most use cases by default. You can also fine-tune the addon configuration to match your project's requirements via the [`./chromatic.config.json`](https://www.chromatic.com/docs/visual-tests-addon/#configure) file. Below are the available options and examples of how to use them.

| Option | Description |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `projectId` | Automatically configured. Sets the value for the project identifier <br/> `options: { projectId: 'Project:64cbcde96f99841e8b007d75' }` |
| `buildScriptName` | Optional. Defines the custom Storybook build script <br/> `options: { buildScriptName: 'deploy-storybook' }` |
| `debug` | Optional. Output verbose debugging information to the console. <br/> `options: { debug: true }` |
| `zip` | Optional. Recommended for large projects. Configures the addon to deploy your Storybook to Chromatic as a zip file. <br/> `options: { zip: true }` |
| Option | Description |
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `projectId` | Automatically configured. Sets the value for the project identifier <br/> `"projectId": "Project:64cbcde96f99841e8b007d75"` |
| `buildScriptName` | Optional. Defines the custom Storybook build script <br/> `"buildScriptName": "deploy-storybook"` |
| `debug` | Optional. Output verbose debugging information to the console. <br/> `"debug": true` |
| `zip` | Optional. Recommended for large projects. Configures the addon to deploy your Storybook to Chromatic as a zip file. <br/> `"zip": true` |

```jsonc
// .storybook/chromatic.config.json
// ./chromatic.config.json
{
"buildScriptName": "deploy-storybook",
"debug": true,
Expand Down

0 comments on commit e5cb586

Please sign in to comment.