Skip to content

docs: add previews: false example #397

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 28, 2024
Merged

docs: add previews: false example #397

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5deea77
docs: added previews: false to the documentation
noam-honig Oct 28, 2024
13dd3c5
docs: typo
AriPerkkio Oct 28, 2024
f7ec5bb
Update configuration.mdx
noam-honig Oct 28, 2024
1d7aa4b
docs: review updates
AriPerkkio Oct 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/tutorialkit.dev/src/content/docs/reference/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,8 +221,8 @@ editor: # Editor is visible

##### `previews`
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.

<PropertyTable inherited type={'Preview[]'} />
Optionally you can hide the preview by providing `previews: false`.
<PropertyTable inherited type={'Preview[] | false'} />

The `Preview` type has the following shape:

Expand All @@ -246,6 +246,9 @@ previews:
- [3003, "Dev Server", "/docs"] # Preview is on :3003/docs/. Displayed title is "Dev Server".
- { port: 3004, title: "Dev Server" } # Preview is on :3004/. Displayed title is "Dev Server".
- { port: 3005, title: "Dev Server", pathname: "/docs" } # Preview is on :3005/docs/. Displayed title is "Dev Server".

previews: false # Do not show preview panel

```

##### `mainCommand`
Expand Down