From dc84565fc0028041a6aefdcc5a60dd6c227bfa2e Mon Sep 17 00:00:00 2001 From: edeediong Date: Tue, 24 Oct 2023 11:49:00 +0100 Subject: [PATCH 01/11] added skipprompt to configuration page --- docs/configuration.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 3e83d304..fb07aebd 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -126,7 +126,7 @@ In most cases, you probably want to set the current working directory at the doc ```sh { cwd=.. } npm run watch #relative path ``` - + ```sh { cwd=/tmp } echo "absolute path" > dummy_file ``` @@ -215,7 +215,7 @@ If you have multiple workflows in a single markdown file you can categorize them ```sh { category=build } # Do something here ``` - + ```sh { category=build,deployment } # Do something here ``` @@ -234,6 +234,7 @@ Frontmatter in yaml, json, or toml on top of markdown document. | ------------- | ----------------------------------------- | ------------------------- | | cwd | Overwrites the default working directory | [markdown file's basedir] | | shell | Overwrites shell with custom preference | [system/user default] | +| skipPrompts | Bypasses interactive prompts | [system/user default] | ### Cell Options @@ -252,6 +253,7 @@ Metadata inside markdown's fenced code blocks. | name | Cell’s canonical name useful for referencing the cell via CLI | auto-generated | | terminalRows | Number of rows to display in the notebook terminal | auto-set | | promptEnv | Prompt user to set exported environment vars | true | +| skipPrompts | Bypasses interactive [prompts](https://docs.runme.dev/configuration#cell-options) that require inputting environment vars or authentication confirmations. |false | ### Supported MIME types From 06f4c365aacc6b6c7f981ab52fc52a5f2a0b9253 Mon Sep 17 00:00:00 2001 From: edeediong Date: Wed, 25 Oct 2023 18:32:57 +0100 Subject: [PATCH 02/11] added an infobox --- docs/configuration.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/configuration.md b/docs/configuration.md index fb07aebd..1be638dd 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -240,6 +240,8 @@ Frontmatter in yaml, json, or toml on top of markdown document. Metadata inside markdown's fenced code blocks. +> **InfoBox**: This feature can be used to prevent prompting when exporting an environment variable. By configuring the cell options appropriately, you can streamline your workflow and make your environment setup more efficient. + | Configuration | Description | Default value | | ---------------------- | --------------------------------------------------------------- | ------------------------ | | background | Indicates if the cell should be runned as a background process | false | @@ -253,7 +255,7 @@ Metadata inside markdown's fenced code blocks. | name | Cell’s canonical name useful for referencing the cell via CLI | auto-generated | | terminalRows | Number of rows to display in the notebook terminal | auto-set | | promptEnv | Prompt user to set exported environment vars | true | -| skipPrompts | Bypasses interactive [prompts](https://docs.runme.dev/configuration#cell-options) that require inputting environment vars or authentication confirmations. |false | +| skipPrompts | Bypasses interactive [prompts](../docs/configuration.md#cell-options) that require inputting environment vars or authentication confirmations. |false | ### Supported MIME types From e57ff1d83497348e06633204078608ae1ebc0bf3 Mon Sep 17 00:00:00 2001 From: edeediong Date: Wed, 25 Oct 2023 18:37:34 +0100 Subject: [PATCH 03/11] changed directory location of prompts --- docs/configuration.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 1be638dd..6a51788a 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -238,9 +238,9 @@ Frontmatter in yaml, json, or toml on top of markdown document. ### Cell Options -Metadata inside markdown's fenced code blocks. +> **SkipPrompts**: This feature can be used to prevent prompting when exporting an environment variable. By configuring the cell options appropriately, you can streamline your workflow and make your environment setup more efficient. -> **InfoBox**: This feature can be used to prevent prompting when exporting an environment variable. By configuring the cell options appropriately, you can streamline your workflow and make your environment setup more efficient. +Metadata inside markdown's fenced code blocks. | Configuration | Description | Default value | | ---------------------- | --------------------------------------------------------------- | ------------------------ | @@ -255,7 +255,7 @@ Metadata inside markdown's fenced code blocks. | name | Cell’s canonical name useful for referencing the cell via CLI | auto-generated | | terminalRows | Number of rows to display in the notebook terminal | auto-set | | promptEnv | Prompt user to set exported environment vars | true | -| skipPrompts | Bypasses interactive [prompts](../docs/configuration.md#cell-options) that require inputting environment vars or authentication confirmations. |false | +| skipPrompts | Bypasses interactive [prompts](/configuration.md#cell-options) that require inputting environment vars or authentication confirmations. |false | ### Supported MIME types From 772002549ddacae5738e0023127d8c6f32b6d872 Mon Sep 17 00:00:00 2001 From: edeediong Date: Wed, 25 Oct 2023 18:40:48 +0100 Subject: [PATCH 04/11] test interactive url --- docs/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration.md b/docs/configuration.md index 6a51788a..58fc1006 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -255,7 +255,7 @@ Metadata inside markdown's fenced code blocks. | name | Cell’s canonical name useful for referencing the cell via CLI | auto-generated | | terminalRows | Number of rows to display in the notebook terminal | auto-set | | promptEnv | Prompt user to set exported environment vars | true | -| skipPrompts | Bypasses interactive [prompts](/configuration.md#cell-options) that require inputting environment vars or authentication confirmations. |false | +| skipPrompts | Bypasses interactive [prompts](/configuration#cell-options) that require inputting environment vars or authentication confirmations. |false | ### Supported MIME types From ef52a0213bc2ac8e4bce807daf1e348f68111308 Mon Sep 17 00:00:00 2001 From: edeediong Date: Wed, 25 Oct 2023 18:45:11 +0100 Subject: [PATCH 05/11] fix broken link' --- docs/configuration.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 58fc1006..c4872dc7 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -236,10 +236,10 @@ Frontmatter in yaml, json, or toml on top of markdown document. | shell | Overwrites shell with custom preference | [system/user default] | | skipPrompts | Bypasses interactive prompts | [system/user default] | -### Cell Options - > **SkipPrompts**: This feature can be used to prevent prompting when exporting an environment variable. By configuring the cell options appropriately, you can streamline your workflow and make your environment setup more efficient. +### Cell Options + Metadata inside markdown's fenced code blocks. | Configuration | Description | Default value | @@ -255,7 +255,7 @@ Metadata inside markdown's fenced code blocks. | name | Cell’s canonical name useful for referencing the cell via CLI | auto-generated | | terminalRows | Number of rows to display in the notebook terminal | auto-set | | promptEnv | Prompt user to set exported environment vars | true | -| skipPrompts | Bypasses interactive [prompts](/configuration#cell-options) that require inputting environment vars or authentication confirmations. |false | +| skipPrompts | Bypasses interactive [prompts](/configuration.md#cell-options) that require inputting environment vars or authentication confirmations. |false | ### Supported MIME types From 8c95bfd5245bb50fdc60a8896744d97a20c739db Mon Sep 17 00:00:00 2001 From: edeediong Date: Wed, 25 Oct 2023 18:47:25 +0100 Subject: [PATCH 06/11] update prompt --- docs/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration.md b/docs/configuration.md index c4872dc7..b71291be 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -255,7 +255,7 @@ Metadata inside markdown's fenced code blocks. | name | Cell’s canonical name useful for referencing the cell via CLI | auto-generated | | terminalRows | Number of rows to display in the notebook terminal | auto-set | | promptEnv | Prompt user to set exported environment vars | true | -| skipPrompts | Bypasses interactive [prompts](/configuration.md#cell-options) that require inputting environment vars or authentication confirmations. |false | +| skipPrompts | Bypasses interactive [prompts](/configuration) that require inputting environment vars or authentication confirmations. |false | ### Supported MIME types From 44d7769715fa04f4c38a0ae10dde85e85e0080dc Mon Sep 17 00:00:00 2001 From: edeediong Date: Thu, 26 Oct 2023 11:19:54 +0100 Subject: [PATCH 07/11] update relative url --- docs/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration.md b/docs/configuration.md index b71291be..0fc40dae 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -255,7 +255,7 @@ Metadata inside markdown's fenced code blocks. | name | Cell’s canonical name useful for referencing the cell via CLI | auto-generated | | terminalRows | Number of rows to display in the notebook terminal | auto-set | | promptEnv | Prompt user to set exported environment vars | true | -| skipPrompts | Bypasses interactive [prompts](/configuration) that require inputting environment vars or authentication confirmations. |false | +| skipPrompts | Bypasses interactive [prompts](/configuration#cell-options) that require inputting environment vars or authentication confirmations. |false | ### Supported MIME types From d917f859d775e6a91465fe624bf022e6825a5f8e Mon Sep 17 00:00:00 2001 From: edeediong Date: Thu, 26 Oct 2023 11:22:54 +0100 Subject: [PATCH 08/11] info box --- docs/configuration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 0fc40dae..e4887ddc 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -236,8 +236,6 @@ Frontmatter in yaml, json, or toml on top of markdown document. | shell | Overwrites shell with custom preference | [system/user default] | | skipPrompts | Bypasses interactive prompts | [system/user default] | -> **SkipPrompts**: This feature can be used to prevent prompting when exporting an environment variable. By configuring the cell options appropriately, you can streamline your workflow and make your environment setup more efficient. - ### Cell Options Metadata inside markdown's fenced code blocks. @@ -257,6 +255,8 @@ Metadata inside markdown's fenced code blocks. | promptEnv | Prompt user to set exported environment vars | true | | skipPrompts | Bypasses interactive [prompts](/configuration#cell-options) that require inputting environment vars or authentication confirmations. |false | +> **SkipPrompts**: This feature can be used to prevent prompting when exporting an environment variable. By configuring the cell options appropriately, you can streamline your workflow and make your environment setup more efficient. + ### Supported MIME types Runme supports the standard VS Code MIME types alongside custom Runme MIME types. From 5607c15757820fe9e01d695c44842e6139bc094b Mon Sep 17 00:00:00 2001 From: edeediong Date: Thu, 26 Oct 2023 15:23:43 +0100 Subject: [PATCH 09/11] updated infobox --- docs/configuration.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/configuration.md b/docs/configuration.md index e4887ddc..dcca97d2 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -255,7 +255,11 @@ Metadata inside markdown's fenced code blocks. | promptEnv | Prompt user to set exported environment vars | true | | skipPrompts | Bypasses interactive [prompts](/configuration#cell-options) that require inputting environment vars or authentication confirmations. |false | -> **SkipPrompts**: This feature can be used to prevent prompting when exporting an environment variable. By configuring the cell options appropriately, you can streamline your workflow and make your environment setup more efficient. + + +This feature can be used to prevent prompting when exporting an environment variable. By configuring the cell options appropriately, you can streamline your workflow and make your environment setup more efficient. + + ### Supported MIME types From f1ba9b71b7b7e306a08a8e6d4006d6b5cc5e8c6d Mon Sep 17 00:00:00 2001 From: edeediong Date: Thu, 26 Oct 2023 15:29:53 +0100 Subject: [PATCH 10/11] update link to infobox --- docs/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration.md b/docs/configuration.md index dcca97d2..bd19ede1 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -257,7 +257,7 @@ Metadata inside markdown's fenced code blocks. -This feature can be used to prevent prompting when exporting an environment variable. By configuring the cell options appropriately, you can streamline your workflow and make your environment setup more efficient. +This feature can be used to prevent [prompting](/configuration#cell-options) when exporting an environment variable. By configuring the cell options appropriately, you can streamline your workflow and make your environment setup more efficient. From 3e87413e76345bb26efefd1147a48b41faa29e98 Mon Sep 17 00:00:00 2001 From: edeediong Date: Thu, 26 Oct 2023 16:23:30 +0100 Subject: [PATCH 11/11] updated the sidenote' --- docs/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration.md b/docs/configuration.md index bd19ede1..62a03376 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -257,7 +257,7 @@ Metadata inside markdown's fenced code blocks. -This feature can be used to prevent [prompting](/configuration#cell-options) when exporting an environment variable. By configuring the cell options appropriately, you can streamline your workflow and make your environment setup more efficient. +This feature can be used to prevent [prompting](/configuration#document-options) when exporting an environment variable. By configuring the [cell options](/configuration#cell-options) appropriately, you can streamline your workflow and make your environment setup more efficient.