Skip to content

Commit 19bc316

Browse files
committed
docs: made some iteration
1 parent 9e07edb commit 19bc316

File tree

1 file changed

+26
-14
lines changed

1 file changed

+26
-14
lines changed

docs/configuration/runme-gist.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,50 +3,57 @@ sidebar_position: 4
33
title: Runme Gist
44
---
55

6-
Runme Gist
76
Would you love to share or store your plain texts or code snippets securely with others in your team without needing a full repository or document?
8-
9-
Runme Gist makes that possible and prioritizes your information's sensitivity by keeping sensitive information secret. In this section, we will explain how Runme Gist works.
7+
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.
108

119
## **What is Runme Gist?**
12-
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 so 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?
10+
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?
1311

1412
## **Installation**
13+
1514
- 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.
16-
- Make Runme your [default Markdown viewer](../installation/installrunme) to ensure all Markdown files are automatically opened as a Runme notebook.
15+
- 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.
16+
1717

18-
## **How Runme Gist Works**
19-
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.
18+
## **Setting Up Runme Gist **
19+
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.
2020

2121
1. Open your Markdown File
22-
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.
22+
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.
2323
2. Run Cells
24-
Run your notebook cells, and ensure the auto-save feature is turned on to save your outputs without manual intervention.
24+
Run your notebook cells, and ensure the [auto-save feature](../configuration/auto-save) is turned on to save your outputs without manual intervention.
2525

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

2828
3. View Sessions Output
29+
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.
30+
2931
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.
3032

3133
![Runme gist session output](../../static/img/configuration-page/runme-gist-sessionoutput.png)
3234

33-
The Session Outputs feature only appears when the autosave is activated and the Runme cell is run.
35+
The Session Outputs feature is only available when the autosave is activated and the Runme cell is run.
3436

3537
4. Toggle Between Mask and Unmask
3638
You can decide if you want your session outputs to be masked or unmasked.
39+
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.
3740
By default, Runme uses the open-source data guardian to mask sensitive information on a best-effort basis.
3841

42+
3943
![Runme gist unmask](../../static/img/configuration-page/runme-gist-unmask.png)
4044

41-
## **Creating and Managing gist With Runme**
45+
## **Creating and Managing Gist with Runme using “Secret Gists”**
4246

4347
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.
4448
To do this, click on “Generate Gist”.
4549

4650
![Runme gist](../../static/img/configuration-page/runme-gist.png)
4751

48-
Runme will first prompt you to log into your GitHub account and grant write access to your Gist. After a successful login, it will display a notification containing a link to the Runme Gist hosted on your GitHub.
49-
The link is generated as a “Secret Gist,” which will stay private as long as you keep it private. Always think twice before sharing the link, and before pushing your sessions to GitHub gist, ensure you use the Runme mask feature to keep your sensitive pieces secured.
52+
Runme will first prompt you to log into your GitHub account and grant write access to your Gist. After a successful login, a notification containing a link to the Runme Gist hosted on your GitHub will be displayed.
53+
54+
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.
55+
Lastly, use the Runme mask feature to keep your sensitive pieces secured.
56+
5057

5158
## **Visual Representation of Runme Gist**
5259
Here is a video that showcases the power of Runme Gist.
@@ -56,4 +63,9 @@ Here is a video that showcases the power of Runme Gist.
5663
<source src="/videos/Runme-gist.webm" type="video/webm" />
5764
</video>
5865

59-
Congratulations, you have successfully learned how to use the Runme Gist feature. Note that it is possible to keep session output files offline and locally. You can read about that here. If you love this feature, kindly give Runme a star on GitHub.
66+
67+
Congratulations! You have successfully learned how to use the Runme Gist feature.
68+
69+
Note that session output files can be kept offline and locally.
70+
You can read about that [here](https://runme.dev/blog/runme-v3-pipeline-logs-and-artifacts). If you love this feature, kindly give [Runme a star](https://github.com/stateful/runme/stargazers) on GitHub.
71+

0 commit comments

Comments
 (0)