Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lucbpz/markdown-cheat-sheet
This repo contains the contents of The Ultimate Markdown Cheat Sheet on cheatography.com
https://github.com/lucbpz/markdown-cheat-sheet
Last synced: 7 days ago
JSON representation
This repo contains the contents of The Ultimate Markdown Cheat Sheet on cheatography.com
- Host: GitHub
- URL: https://github.com/lucbpz/markdown-cheat-sheet
- Owner: lucbpz
- Created: 2017-10-04T11:17:58.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-10-04T11:38:33.000Z (over 7 years ago)
- Last Synced: 2024-11-08T04:39:24.586Z (about 2 months ago)
- Homepage:
- Size: 1.95 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
THE ULTIMATE MARKDOWN CHEAT SHEET
===
Hello everyone! I just needed a Markdown cheat sheet and neither of the ones here resolved my problems when I had to write my article, so I decided to create my own. Really simple and condensed so you don't have to go to other resource to complete your writing!
Some of the features may not be available as they are from Extended Markdown.
Download my cheat sheet here!
https://www.cheatography.com/lucbpz/cheat-sheets/the-ultimate-markdown/
I suggest using VS Code and the extension "Auto-Open Markdown Preview".
---
# HEADERS
```
Heading Level 1
========
Heading Level 2
-----------
Another way:
# Header1
## Header2
### Header3
...
```
Heading Level 1
========
Heading Level 2
--------
Another way:
# Header1
## Header2
### Header3
---
# PARAGRAPHS < p >
```
Paragraphs are lines of text
(single returns are collapsed into a space)
Blank lines indicate a new paragraph
```
Paragraphs are lines of text
(single returns are collapsed into a space)
Blank lines indicate a new paragraph
---
# TEXT EFFECTS
```
**bold**
*italic*
~~strikethrough~~
```
**bold**
*italic*
~~strikethrough~~
---
# CODE
```
Simple html < code > text: `code`
Code block (< pre >) in a certain language:
``` javascript
if (isBad) {
return false
}
```
Simple html < code > text: `code`
Code block (< pre >) in a certain language:
``` javascript
if (isBad) {
return false
}
```
---
# HORIZONTAL RULE < hr />
```
---
- - -
```
---
---
# LINKS & LINK TO A SECTION
```
[Text that will link to a website.](http://www.web.com)
[Text that will link to the section images](#images)
This will link the text to the "Images" header. Use - instead of spaces for the link.
You can also organize all your links like this:
[math.stackexchange.com][1]
[link.number.two][2]
[1]: http://math.stackexchange.com/
[2]: http://website.com
```
[Text that will link to a website](http://www.web.com)
[Text that will link to the section images](#images)
This will link the text to the "Images" header. Use - instead of spaces for the link.
You can also organize all your links like this:
[math.stackexchange.com][1]
[link.number.two][2]
[1]: http://math.stackexchange.com/
[2]: http://website.com
---
# IMAGES
```
```
---
# UNORDERED LIST < ul > < li >
```
* First bullet
* Second bullet
* * Second.1 bullet
```
* First bullet
* Second bullet
* * Second.1 bullet
---
# ORDERED LIST < ol > < li >
```
1. First item
2. Second item
3. Third item
```
1. First item
2. Second item
3. Third item
---
# TABLES
```
| Item | Value | Qty |
| :------- | ----: | :---: |
| Computer | $1600 | 5 |
You can specify alignment with : at one or both sides
```
| Item | Value | Qty |
| :------- | ----: | :---: |
| Computer | $1600 | 5 |
You can specify alignment with : at one or both sides
---
# ADDING ICONS
```
i> Create a document
This would add the icon before the text
```
i> Create a document
This would add the icon before the text
---
# KEYBOARD KEYS
```
Ctrl+Shift+F1
```
Ctrl+Shift+F1
---
# TABLE OF CONTENTS
```
You can insert a table of contents using the
marker
[TOC]
```
You can insert a table of contents using the
marker
[TOC]
---
# FOOTNOTES
```
You can create footnotes like
this[^footnoteName].
[^footnoteName]: Here is thetext of the
footnote.
Every time you create a footnote it
automatically sets the text at the bottom of the
page and link them together
```
You can create footnotes like
this[^footnoteName].
[^footnoteName]: Here is thetext of the
footnote.
Every time you create a footnote it
automatically sets the text at the bottom of the
page and link them together
---
# DEFINITION LIST
```
Belongs to this term
: This definition
First, write the syntax for the definition
```
Belongs to this term
: This definition
First, write the syntax for the definition
---
# FLOWCHARTS
```
st=>start: Start
e=>end
op1=>operation: My Operation
sub1=>subroutine: My Subroutine
cond=>condition: Yes
or No?:>http://www.google.com
io=>inputoutput: catch something...
st->op1->cond
cond(yes)->io->e
cond(no)->sub1(right)->op1
You can have more info at: http://flowchart.js.org/
```
st=>start: Start
e=>end
op1=>operation: My Operation
sub1=>subroutine: My Subroutine
cond=>condition: Yes
or No?:>http://www.google.com
io=>inputoutput: catch something...
st->op1->cond
cond(yes)->io->e
cond(no)->sub1(right)->op1
You can have more info at: http://flowchart.js.org/
---
# SEQUENCE DIAGRAMS
```
Andrew->China: Says Hello
Note right of China: China thinks\nabout it
China-->Andrew: How are you?
Andrew->>China: I am good thanks!
You can have more info at: https://bramp.github.io/js-sequence-diagrams/
```
Andrew->China: Says Hello
Note right of China: China thinks\nabout it
China-->Andrew: How are you?
Andrew->>China: I am good thanks!
You can have more info at: https://bramp.github.io/js-sequence-diagrams/