From 5deea779103a50e72503a792833f4a39ab90febc Mon Sep 17 00:00:00 2001 From: Noam Honig Date: Mon, 28 Oct 2024 12:34:46 +0200 Subject: [PATCH 1/4] docs: added previews: false to the documentation --- .../src/content/docs/reference/configuration.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/tutorialkit.dev/src/content/docs/reference/configuration.mdx b/docs/tutorialkit.dev/src/content/docs/reference/configuration.mdx index 03fd3cb8d..ae0e64d66 100644 --- a/docs/tutorialkit.dev/src/content/docs/reference/configuration.mdx +++ b/docs/tutorialkit.dev/src/content/docs/reference/configuration.mdx @@ -230,6 +230,7 @@ The `Preview` type has the following shape: type Preview = | number | string + | false | [port: number, title: string] | [port: number, title: string, pathname: string] | { port: number, title: string, pathname?: string } @@ -242,6 +243,7 @@ Example value: previews: - 3000 # Preview is on :3000/ - "3001/docs" # Preview is on :3001/docs/ + - false # do not show peview panel - [3002, "Dev Server"] # Preview is on :3002/. Displayed title is "Dev Server". - [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". From 13dd3c5f72a46a756bcd758d25c6418156462d62 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ari=20Perkki=C3=B6?= Date: Mon, 28 Oct 2024 12:39:33 +0200 Subject: [PATCH 2/4] docs: typo --- .../src/content/docs/reference/configuration.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorialkit.dev/src/content/docs/reference/configuration.mdx b/docs/tutorialkit.dev/src/content/docs/reference/configuration.mdx index ae0e64d66..5a631e1e8 100644 --- a/docs/tutorialkit.dev/src/content/docs/reference/configuration.mdx +++ b/docs/tutorialkit.dev/src/content/docs/reference/configuration.mdx @@ -243,7 +243,7 @@ Example value: previews: - 3000 # Preview is on :3000/ - "3001/docs" # Preview is on :3001/docs/ - - false # do not show peview panel + - false # Do not show preview panel - [3002, "Dev Server"] # Preview is on :3002/. Displayed title is "Dev Server". - [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". From f7ec5bb23898cfdf324596dfdcf76ca56aed6bb8 Mon Sep 17 00:00:00 2001 From: Noam Honig Date: Mon, 28 Oct 2024 13:03:06 +0200 Subject: [PATCH 3/4] Update configuration.mdx --- .../src/content/docs/reference/configuration.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorialkit.dev/src/content/docs/reference/configuration.mdx b/docs/tutorialkit.dev/src/content/docs/reference/configuration.mdx index 5a631e1e8..6eb4b1e65 100644 --- a/docs/tutorialkit.dev/src/content/docs/reference/configuration.mdx +++ b/docs/tutorialkit.dev/src/content/docs/reference/configuration.mdx @@ -243,11 +243,11 @@ Example value: previews: - 3000 # Preview is on :3000/ - "3001/docs" # Preview is on :3001/docs/ - - false # Do not show preview panel - [3002, "Dev Server"] # Preview is on :3002/. Displayed title is "Dev Server". - [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` From 1d7aa4b5895e076bcea34f35797899f40dd7a05b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ari=20Perkki=C3=B6?= Date: Mon, 28 Oct 2024 17:19:45 +0200 Subject: [PATCH 4/4] docs: review updates --- .../src/content/docs/reference/configuration.mdx | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/tutorialkit.dev/src/content/docs/reference/configuration.mdx b/docs/tutorialkit.dev/src/content/docs/reference/configuration.mdx index 6eb4b1e65..89c1ab12a 100644 --- a/docs/tutorialkit.dev/src/content/docs/reference/configuration.mdx +++ b/docs/tutorialkit.dev/src/content/docs/reference/configuration.mdx @@ -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. - - +Optionally you can hide the preview by providing `previews: false`. + The `Preview` type has the following shape: @@ -230,7 +230,6 @@ The `Preview` type has the following shape: type Preview = | number | string - | false | [port: number, title: string] | [port: number, title: string, pathname: string] | { port: number, title: string, pathname?: string } @@ -247,7 +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`