Folded content
Use a `` HTML tag:
```md
```
Fold/Open
Folded contentMath
Inline expressions: surround the expression with `$`. ```md $\sum_{n=1}^{10} n^2$ ``` $\sum_{n=1}^{10} n^2$ Block expressions: surround the expression with `$$`. ```md $$\sum_{n=1}^{10} n^2$$ ``` $$\sum_{n=1}^{10} n^2$$Syntax highlighting in code blocks
Specify the language right after the code block's opening: ```ruby def index puts "hello world" end ``` ```csharp private void index(){ MessageBox.Show("hello world"); } ``` Refer [Syntax highlighting in markdown] and [linguist supported language syntax list] for recognized languages and their aliases.To do lists
Use `[ ]` after the bullet point or numbered list character to switch them for an empty ballot box, and `[x]` for a checked one. 1. [ ] 1 1. [ ] 2 - [x] a - [x] Point 3
```md
| column 1 | column 2 | column 3 |
| -------- | -------- | ----------------------------- |
| a | b
b |
b |
Text in columns can be aligned by putting `:` in the header delimiter line where the alignment should be.b |
- c
- c
b |
- c
- c
`:---` = left, `---:` = right, `:---:` = center.
```md
| column 4 | column 5 | column 6 |
| :------- | :------: | -------: |
| a | b | c |
```
| column 4 | column 5 | column 6 |
| :------- | :------: | -------: |
| a | b | c |
## Alerts
Alerts are **not** defined in the base Markdown specification.They are extensions that the most famous flavours introduced or adopted, each with small but annoying differences.
GitHub formatting
Refer [GitHub's alert formatting][github formatting alerts]. ```md > [!NOTE] > Useful information that users should know, even when skimming content. > [!TIP] > Helpful advice for doing things better or more easily. > [!IMPORTANT] > Key information users need to know to achieve their goal. > [!WARNING] > Urgent info that needs immediate user attention to avoid problems. > [!CAUTION] > Advises about risks or negative outcomes of certain actions. ``` --- > [!NOTE] > Useful information that users should know, even when skimming content. --- > [!TIP] > Helpful advice for doing things better or more easily. --- > [!IMPORTANT] > Key information users need to know to achieve their goal. --- > [!WARNING] > Urgent info that needs immediate user attention to avoid problems. --- > [!CAUTION] > Advises about risks or negative outcomes of certain actions.GitLab formatting
Refer [GitLab Flavored Markdown][gitlab flavored markdown alerts]. ```md > [!note] > Information that users should take into account, even when skimming. > [!tip] > Optional information to help a user be more successful. > [!important] > Crucial information necessary for users to succeed. > [!caution] > Negative potential consequences of an action. > [!warning] > Critical potential risks. ``` --- > [!note] > Information that users should take into account, even when skimming. --- > [!tip] > Optional information to help a user be more successful. --- > [!important] > Crucial information necessary for users to succeed. --- > [!caution] > Negative potential consequences of an action. --- > [!warning] > Critical potential risks.
```
- Center the image:
```md
```
## Troubleshooting
### Escape the backtick character
Include a non-code formatted backtick by escaping it normally (with a `\`).
Render it in an inline code block using double backticks instead of single backticks.
Alternatively, use a code block. This will wrap everything in a `` HTML tag.
To do this, either indent 4 spaces to start a code block, or use fenced code blocks if supported. ### Render mermaid.js graphs in VS Code's Markdown preview Install and enable [`bierner.markdown-mermaid`][bierner.markdown-mermaid]'s extension. ## Further readings - Official [documentation] - [Extended syntax] - [Linguist supported language syntax list] - [Github's alert formatting][github formatting alerts] - [Live editor] - [Mermaid.js] - [MyST] extension for technical, scientific communication and publication ### Sources - [Basic syntax] - [Code blocks] - [Escaping backticks] - [Escaping backtick in Markdown] - [The magical Markdown I bet you don't know] - [slaise/High-level-Markdown] - [Syntax highlighting in Markdown] - [Writing on GitHub] - [GitLab Flavored Markdown] [mermaid.js]: mermaid.js.md [basic syntax]: https://www.markdownguide.org/basic-syntax [code blocks]: https://docs.readme.com/rdmd/docs/code-blocks [documentation]: https://docs.readme.com/rdmd/docs [extended syntax]: https://www.markdownguide.org/extended-syntax/ [babelmark]: https://babelmark.github.io/ [bierner.markdown-mermaid]: https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid [escaping backtick in markdown]: https://www.growingwiththeweb.com/2015/06/escaping-backtick-in-markdown.html [escaping backticks]: https://www.markdownguide.org/basic-syntax/#escaping-backticks [github formatting alerts]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts [GitLab Flavored Markdown alerts]: https://docs.gitlab.com/user/markdown/#alerts [GitLab Flavored Markdown]: https://docs.gitlab.com/user/markdown/ [linguist supported language syntax list]: https://github.com/github/linguist/blob/master/lib/linguist/languages.yml [live editor]: https://mermaid.live/edit [myst]: https://mystmd.org/ [slaise/high-level-markdown]: https://github.com/slaise/High-level-Markdown [syntax highlighting in markdown]: https://support.codebasehq.com/articles/tips-tricks/syntax-highlighting-in-markdown [the magical markdown i bet you don't know]: https://medium.com/codex/the-magical-markdown-i-bet-you-dont-know-b51f8c049773 [Writing on GitHub]: https://docs.github.com/en/get-started/writing-on-github