mirror of
https://github.com/cotes2020/chirpy-starter.git
synced 2025-04-21 11:53:27 +10:00
151 lines
2.5 KiB
Markdown
151 lines
2.5 KiB
Markdown
---
|
||
title: Markdown Cheatsheet
|
||
date: 2023-08-23 15:33:19
|
||
catagories: [documentation, cheatsheets]
|
||
tags: [docs, cheatsheet, markdown]
|
||
---
|
||
|
||
# Markdown Cheat Sheet
|
||
|
||
>**Note**
|
||
>Use `source mode` to view the source for easier guidance on markdown syntax.
|
||
|
||
Ad-note syntax:
|
||
|
||
```ad-note
|
||
color: 83, 188, 109
|
||
Hello this is a note.
|
||
```
|
||
|
||
you can change the color by using the RGB color picker: https://g.co/kgs/Mig2hN
|
||
|
||
|
||
## Text highlight
|
||
```
|
||
<span style="color:yellow">Insert text here.</span>
|
||
```
|
||
|
||
Thanks for visiting [The Markdown Guide](https://www.markdownguide.org)!
|
||
|
||
This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements. It can’t cover every edge case, so if you need more information about any of these elements, refer to the reference guides for [basic syntax](https://www.markdownguide.org/basic-syntax) and [extended syntax](https://www.markdownguide.org/extended-syntax).
|
||
|
||
## Basic Syntax
|
||
|
||
These are the elements outlined in John Gruber’s original design document. All Markdown applications support these elements.
|
||
|
||
### Heading
|
||
|
||
# H1
|
||
## H2
|
||
### H3
|
||
|
||
### Bold
|
||
|
||
**bold text**
|
||
|
||
### Italic
|
||
|
||
*italicized text*
|
||
|
||
### Blockquote
|
||
|
||
> blockquote
|
||
|
||
### Ordered List
|
||
|
||
1. First item
|
||
2. Second item
|
||
3. Third item
|
||
|
||
### Unordered List
|
||
|
||
- First item
|
||
- Second item
|
||
- Third item
|
||
|
||
### Code
|
||
|
||
`code`
|
||
|
||
### Horizontal Rule
|
||
|
||
---
|
||
|
||
### Link
|
||
|
||
[Markdown Guide](https://www.markdownguide.org)
|
||
|
||
### Image
|
||
|
||
|
||
|
||
## Extended Syntax
|
||
|
||
These elements extend the basic syntax by adding additional features. Not all Markdown applications support these elements.
|
||
|
||
### Table
|
||
|
||
| Syntax | Description |
|
||
| ----------- | ----------- |
|
||
| Header | Title |
|
||
| Paragraph | Text |
|
||
|
||
### Fenced Code Block
|
||
|
||
```
|
||
{
|
||
"firstName": "John",
|
||
"lastName": "Smith",
|
||
"age": 25
|
||
}
|
||
```
|
||
|
||
### Footnote
|
||
|
||
Here's a sentence with a footnote. [^1]
|
||
|
||
[^1]: This is the footnote.
|
||
|
||
### Heading ID
|
||
|
||
### My Great Heading {#custom-id}
|
||
|
||
### Definition List
|
||
|
||
term
|
||
: definition
|
||
|
||
### Strikethrough
|
||
|
||
~~The world is flat.~~
|
||
|
||
### Task List
|
||
|
||
- [x] Write the press release
|
||
- [ ] Update the website
|
||
- [ ] Contact the media
|
||
|
||
### Emoji
|
||
|
||
That is so funny! :joy:
|
||
|
||
(See also [Copying and Pasting Emoji](https://www.markdownguide.org/extended-syntax/#copying-and-pasting-emoji))
|
||
|
||
### Highlight
|
||
|
||
I need to highlight these ==very important words==.
|
||
|
||
### Subscript
|
||
|
||
H~2~O
|
||
|
||
### Superscript
|
||
|
||
X^2^
|
||
|
||
### Additional Resources
|
||
|
||
- [Highlight a note or warning in blockquote](https://github.com/community/community/discussions/16925)
|
||
|
||
![[Pasted image 20230330125153.png]]
|