Skip to content

Commit 862fcbe

Browse files
committed
Updates
1 parent 2a5874a commit 862fcbe

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

learn-pr/github/introduction-to-github/includes/2-what-is-github.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,7 @@ Gists are a feature of GitHub that allows users to share code snippets, notes, o
140140

141141
5. **Markdown Support**:
142142
- Gists support Markdown formatting, which means you can include rich text, headings, links, and even images alongside your code. This is particularly useful for adding context or explanations to your snippets.
143+
- Code blocks are automatically rendered with syntax highlighting, making your snippets easy to read.
143144

144145
6. **Collaboration**:
145146
- While gists are typically used for individual snippets, they can also be shared and collaborated on by multiple users. Forking and commenting on gists enable lightweight collaboration.
@@ -151,6 +152,10 @@ Gists are a feature of GitHub that allows users to share code snippets, notes, o
151152
- Sharing error logs or debugging information with others.
152153
- Embedding code snippets in blogs, forums, or documentation.
153154

155+
[!IMPORTANT]
156+
> **Never include secrets, passwords, API keys, or sensitive data in gists—even in scripts or config files.**
157+
> Gists (including secret gists) can be accessed by anyone with the link, so always double-check your content before sharing.
158+
154159
#### Limitations of Gists:
155160
- Gists are not entirely private, even if marked as secret. Anyone with the URL can access them, so they should not be used for sensitive or confidential information.
156161
- They are best suited for small snippets or single files. For larger projects or multi-file structures, a full repository is more appropriate.

0 commit comments

Comments
 (0)