CHEATSHEET.md

Markdown Cheat Sheet

Markdown Cheat Sheet for Markdown-Writer Package.

To use the key mappings listed, please execute command Markdown Writer: Create Default Keymaps. Refer to wiki for more details.

Headings

Key Mapping: Ctrl + Alt + 1-5

# heading 1
## heading 2
### heading 3
#### heading 4
##### heading 5

Emphasis

• italics: _underscores_. (Cmd + i)
• Strong: **two asterisks** (Cmd + b)
• Strikethrough: ~~two tildes~~ (Cmd + h)

Lists

Ordered List

Key Mapping: Cmd + Shift + O

1. List 1
  1. Inner list 1
  2. Inner list 2
2. List 2

TIP: Use command Markdown Writer:Format Order List if the order numbers are messed up.

Unordered List

Key Mapping: Cmd + Shift + U

- List 1
  - Inner list 1
- List 2

TIP: You can config different bullet styles at different nested levels. Refer to wiki.

Task List

Key Mapping: Cmd + Shift + X

- [ ] List 1
  - [x] Inner list 1
  - [ ] Inner list 2

Links

Key Mapping: Cmd + Shift + K

inline-style [link](https://www.google.com) is inline.

reference-style [link][id] uses `id`.

  [id]: https://www.google.com

Images

Key Mapping: Cmd + Shift + I

![image](https://example.com/image.png)

Blockquotes

Key Mapping: Cmd + Shift + >

As Kanye West said:

> We're living the future so
> the present is our past.

Inline Code

Key Mapping: Cmd + '

inline code snippet is `var code = 1;`

Code Blocks

Key Mapping: Cmd + Shift + '

You can indent code blocks by 4 spaces or use fenced code block:

```
$(function() {
  alert("hello world");
});
```

Tables

Command: Markdown Writer: Insert Table (shift + cmd + P)

First Header                | Second Header
----------------------------|-----------------------------
Content from cell 1         | Content from cell 2
Content in the first column | Content in the second column

TIP: Use command Markdown Writer:Format Table to format table cells.

Horizontal Rule

Use three or more hyphens.

Horizontal rule

---

Next paragraph.

Footnote

Command: Markdown Writer: Insert Footnote

This is some text.[^1]

  [^1]: Some *crazy* footnote definition.

Inline HTML

You can also use raw HTML in your Markdown, and it'll mostly work pretty well.

<dl>
  <dt>Definition list</dt>
  <dd>Is something people use sometimes.</dd>

  <dt>Markdown in HTML</dt>
  <dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd>
</dl>

More

All Markdown Writer commands can be found by:

• Command Palette shift + cmd + P , type Markdown Writer
• Menu Bar -> Packages -> Markdown Writer

If you prefer to have editing buttons, please try out Toolbar for Markdown-Writer.