Skip to content

Commit 504ec10

Browse files
committed
docs: change title
1 parent 47f3955 commit 504ec10

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

docs/configuration/runme-gist.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,27 @@ Would you love to share or store your plain texts or code snippets securely with
44
Runme Gist makes this possible and prioritizes your information's sensitivity by keeping sensitive information secret. In this section, we will explain how Runme Gist works.
55

66
## **What is Runme Gist?**
7+
78
Runme Gist combines GitHub Gist with Runme capabilities to run, share, and store plain texts or code snippets in your Markdown file. What makes Runme Gist powerful is its ability to capture outputs and mask sensitive data without copying and pasting or integrating a third-party tool. You have everything done inside your Markdown file. Amazing right?
89

910
## **Installation**
1011

1112
- To utilize the Runme Gist feature, ensure the [Runme extension](../installation/installrunme) is installed in your VS Code. If you already have Runme installed in your VS Code, ensure you are upgraded to v3.4.0.
1213
- Set Runme as your [default Markdown viewer](../installation/installrunme) to ensure all Markdown files in your code editor are automatically opened as a Runme notebook.
1314

14-
1515
## **Setting Up Runme Gist**
16+
1617
As stated earlier, Runme Gist combines GitHub Gist with Runme capabilities to enable you to securely run, share, and store code snippets. In this section, we will explain how Runme Gist works using a step-by-step guide.
1718

1819
1. Open your Markdown File
19-
Create a `README.md` file and open it in your VS Code. If you already have the file you want to use, open it in VS Code.
20+
Create a `README.md` file and open it in your VS Code. If you already have the file you want to use, open it in VS Code.
2021
2. Run Cells
21-
Run your notebook cells, and ensure the [auto-save feature](../configuration/auto-save) is turned on to save your outputs without manual intervention.
22+
Run your notebook cells, and ensure the [auto-save feature](../configuration/auto-save) is turned on to save your outputs without manual intervention.
2223

2324
![runme gist Autosave ](../../static/img/configuration-page/runme-gist-autosave.png)
2425

2526
3. View Sessions Output
26-
Session output is a Runme feature that stores your generated cell outputs to a separate file to enable you access the output whenever you need. See the [Session output](../configuration/auto-save#session-outputs) guide.
27+
Session output is a Runme feature that stores your generated cell outputs to a separate file to enable you access the output whenever you need. See the [Session output](../configuration/auto-save#session-outputs) guide.
2728

2829
To view your session output, click “Sessions Outputs” to inspect the locally recorded session. Alternatively, you can find it on the left-hand side of your VS Code right inside your current working directory.
2930

@@ -32,14 +33,13 @@ To view your session output, click “Sessions Outputs” to inspect the locally
3233
The Session Outputs feature is only available when the autosave is enabled and the Runme cell is run.
3334

3435
4. Toggle Between Mask and Unmask
35-
You can decide if you want your session outputs to be masked or unmasked.
36-
The masked and unmasked options are how Runme keeps your sensitive information secret. If you want to keep your sensitive information secret, you should toggle the mask option otherwise, choose the unmasked option.
37-
Otherwise, Runme uses the open-source `data-guardian` library to mask sensitive information on a best-effort basis.
38-
36+
You can decide if you want your session outputs to be masked or unmasked.
37+
The masked and unmasked options are how Runme keeps your sensitive information secret. If you want to keep your sensitive information secret, you should toggle the mask option otherwise, choose the unmasked option.
38+
Otherwise, Runme uses the open-source `data-guardian` library to mask sensitive information on a best-effort basis.
3939

4040
![Runme gist unmask](../../static/img/configuration-page/runme-gist-unmask.png)
4141

42-
## **Creating and Managing gist with Runme using Secret Gists**
42+
## **Creating and Managing Gist with Runme using Secret Gists**
4343

4444
GitHub Gist is a service provided by GitHub that allows users to share code snippets, notes, and other small pieces of text with others. With a single click, you can push your Runme Session Output to GitHub Gist from your Markdown file.
4545
To do this, click on “Generate Gist”.
@@ -51,16 +51,15 @@ Runme will first prompt you to log into your GitHub account and grant write acce
5151
The link is generated as a “Secret Gist,” which will stay private as long as you keep it private. Ensure you secure the link cautiously before pushing your sessions to GitHub Gist.
5252
Lastly, use the Runme mask feature to keep your sensitive pieces secured.
5353

54-
5554
## **Visual Representation of Runme Gist**
55+
5656
Here is a video that showcases the power of Runme Gist.
5757

5858
<video autoPlay loop muted playsInline controls>
5959
<source src="/videos/Runme-gist.mp4" type="video/mp4" />
6060
<source src="/videos/Runme-gist.webm" type="video/webm" />
6161
</video>
6262

63-
6463
Congratulations! You have successfully learned how to use the Runme Gist feature.
6564

6665
Note that session output files can be kept offline and locally.

0 commit comments

Comments
 (0)