https://github.com/thinkverse/useful-gh-markdown
Useful GitHub flavored markdown snippets
https://github.com/thinkverse/useful-gh-markdown
github github-markdown github-readme markdown useful-md-snippets
Last synced: 3 months ago
JSON representation
Useful GitHub flavored markdown snippets
- Host: GitHub
- URL: https://github.com/thinkverse/useful-gh-markdown
- Owner: thinkverse
- Created: 2022-08-17T15:30:35.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-16T12:01:25.000Z (about 2 years ago)
- Last Synced: 2025-04-10T23:12:50.344Z (9 months ago)
- Topics: github, github-markdown, github-readme, markdown, useful-md-snippets
- Homepage:
- Size: 22.5 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Useful GitHub Flavored Markdown Snippets
## Alerts
> Previously knows as "*Enhanced Blockquotes*."
You can read about Alerts in the [documentation](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts).
- [x] Works on GitHub mobile app.
```md
> [!NOTE]
> BLOCKQUOTE_TEXT
```
> [!NOTE]
> This repository contains `GitHub Flavored Markdown`.
```md
> [!WARNING]
> BLOCKQUOTE_TEXT
```
> [!WARNING]
> This only works on GitHub, or services where this is supported.
#### July 2023 Update!
As of July 2023, we got a new `IMPORTANT` type and a new `![TYPE]` syntax. You can read more about it in the [discussion](https://github.com/orgs/community/discussions/16925).
```md
> [!IMPORTANT]
> BLOCKQUOTE_TEXT
```
#### November 2023 Update!
As of November 2023, we have two more types: `TIP` and `CAUTION`.
```md
> [!TIP]
> BLOCKQUOTE_TEXT
```
> [!TIP]
> This became available on 14th November 2023.
```md
> [!CAUTION]
> BLOCKQUOTE_TEXT
```
> [!CAUTION]
> Might not be supported on other platforms.
## Context-based images
### HTML version
- [x] Works on GitHub mobile app.
Specify an image to display based on the preferred color scheme. Change your color scheme from light to dark or vice-versa to see the image change.
```md
```
Source: [Specify theme context for images in Markdown GA](https://github.blog/changelog/2022-08-15-specify-theme-context-for-images-in-markdown-ga/)
### Markdown version
- [x] Works on GitHub mobile app.
GitHub also supports themed images in Markdown, by appending `#gh-dark-mode-only` or `#gh-light-mode-only` at the end of an image url.
```md
```
Source: [Specify theme context for images in Markdown](https://github.blog/changelog/2021-11-24-specify-theme-context-for-images-in-markdown/)
## Fence blocks for Math
- [ ] Works on GitHub mobile app.
You can specify a math-specific fence block with ` ```math `, it even supports LaTeX expressions, read more about it in the [documentation](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions).
````md
```math
\sqrt{3}
```
````
```math
\sqrt{3}
```
Source: [Fenced block syntax for mathematical expressions](https://github.blog/changelog/2022-06-28-fenced-block-syntax-for-mathematical-expressions/)