Skip to content

Commit e288f4e

Browse files
authored
docs: add previews: false docs and example (#397)
1 parent a824f15 commit e288f4e

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

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

+5-2
Original file line numberDiff line numberDiff line change
@@ -221,8 +221,8 @@ 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

@@ -246,6 +246,9 @@ previews:
246246
- [3003, "Dev Server", "/docs"] # Preview is on :3003/docs/. Displayed title is "Dev Server".
247247
- { port: 3004, title: "Dev Server" } # Preview is on :3004/. Displayed title is "Dev Server".
248248
- { port: 3005, title: "Dev Server", pathname: "/docs" } # Preview is on :3005/docs/. Displayed title is "Dev Server".
249+
250+
previews: false # Do not show preview panel
251+
249252
```
250253

251254
##### `mainCommand`

0 commit comments

Comments
 (0)