Markdown

Lightweight markup language - simple syntax for docs, READMEs, notes that converts to HTML

TL;DR

What: Lightweight markup language for creating formatted text.

Why: Write docs, READMEs, notes with simple syntax that converts to HTML.

Quick Start

Headers:

# H1 Header
## H2 Header
### H3 Header

Text formatting:

**bold text**
*italic text*
~~strikethrough~~
`inline code`

Lists:

- Unordered item
- Another item
  - Nested item

1. Ordered item
2. Another item

Links and images:

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

Code blocks:

```javascript
const greeting = "Hello, World!";
console.log(greeting);
```

Cheatsheet

SyntaxResult
**bold**bold
*italic*italic
~~strike~~strike
`code`code
[text](url)link
![alt](img)image
> quoteblockquote
---horizontal rule

Tables:

| Header 1 | Header 2 |
|----------|----------|
| Cell 1   | Cell 2   |
| Cell 3   | Cell 4   |

Task lists (GitHub Flavored):

- [x] Completed task
- [ ] Pending task

Gotchas

Line breaks not working

<!-- Add two spaces at end of line  -->
Line one
Line two

<!-- Or use blank line for paragraph -->
Paragraph one

Paragraph two

Images not showing

<!-- Use relative path -->
![Screenshot](./images/screenshot.png)

<!-- Or absolute URL -->
![Logo](https://example.com/logo.png)

Code block language highlighting

<!-- Specify language after backticks -->
```python
print("Hello")
```

```bash
echo "Hello"
```

Escaping special characters

\* Not italic \*
\# Not a header
\[Not a link\]

Next Steps