Skip to content

Commit 1d7aa4b

Browse files
committed
docs: review updates
1 parent f7ec5bb commit 1d7aa4b

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/tutorialkit.dev/src/content/docs/reference/configuration.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -221,16 +221,15 @@ editor: # Editor is visible
221221
222222
##### `previews`
223223
Configure which ports should be used for the previews allowing you to align the behavior with your demo application's dev server setup. If not specified, the lowest port will be used.
224-
225-
<PropertyTable inherited type={'Preview[]'} />
224+
Optionally you can hide the preview by providing `previews: false`.
225+
<PropertyTable inherited type={'Preview[] | false'} />
226226

227227
The `Preview` type has the following shape:
228228

229229
```ts
230230
type Preview =
231231
| number
232232
| string
233-
| false
234233
| [port: number, title: string]
235234
| [port: number, title: string, pathname: string]
236235
| { port: number, title: string, pathname?: string }
@@ -247,7 +246,9 @@ previews:
247246
- [3003, "Dev Server", "/docs"] # Preview is on :3003/docs/. Displayed title is "Dev Server".
248247
- { port: 3004, title: "Dev Server" } # Preview is on :3004/. Displayed title is "Dev Server".
249248
- { port: 3005, title: "Dev Server", pathname: "/docs" } # Preview is on :3005/docs/. Displayed title is "Dev Server".
249+
250250
previews: false # Do not show preview panel
251+
251252
```
252253

253254
##### `mainCommand`

0 commit comments

Comments
 (0)