Add couple doc images and markdown cheat sheet
This commit is contained in:
parent
56d6e412f2
commit
777e81ae43
BIN
assets/images/OpenGenesis1:1.png
Normal file
BIN
assets/images/OpenGenesis1:1.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 8.8 KiB |
BIN
assets/images/ReferenceOpener.png
Normal file
BIN
assets/images/ReferenceOpener.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 4.3 KiB |
97
docs/markdown-cheat-sheet.md
Normal file
97
docs/markdown-cheat-sheet.md
Normal file
@ -0,0 +1,97 @@
|
|||||||
|
# Markdown Cheat Sheet
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
![alt text](https://www.markdownguide.org/assets/images/tux.png)
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"firstName": "John",
|
||||||
|
"lastName": "Smith",
|
||||||
|
"age": 25
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Footnote
|
||||||
|
|
||||||
|
Here's a sentence with a footnote. [^1]
|
||||||
|
|
||||||
|
[^1]: This is the footnote.
|
||||||
|
|
||||||
|
### Definition List
|
||||||
|
|
||||||
|
term
|
||||||
|
: definition
|
||||||
|
|
||||||
|
### Strikethrough
|
||||||
|
|
||||||
|
~~The world is flat.~~
|
||||||
|
|
||||||
|
### Task List
|
||||||
|
|
||||||
|
- [x] Write the press release
|
||||||
|
- [ ] Update the website
|
||||||
|
- [ ] Contact the media
|
Loading…
Reference in New Issue
Block a user