Master Markdown formatting to create beautiful documentation and text content
Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents. Created by John Gruber in 2004, Markdown is now one of the world's most popular markup languages.
Syntax | Description | Example | Result |
---|---|---|---|
# Heading 1 | Main heading | # Welcome | Large main heading text |
## Heading 2 | Sub-heading | ## Chapter 1 | Smaller sub-heading text |
**text** | Bold text | **important** | important |
*text* | Italic text | *emphasized* | emphasized |
[link](url) | Hyperlink | [Google](https://google.com) | Clickable link to Google |
* item | Unordered list | * First
* Second | Bulleted list |
1. item | Ordered list | 1. First
2. Second | Numbered list |
> text | Blockquote | > Important quote | Indented blockquote |
`code` | Inline code | `var x = 10;` | Monospaced code text |
```
code block
``` | Code block | ```
function hello() {
return "Hi";
}``` | Multi-line code block |
--- | Horizontal rule | --- | Horizontal line |
![alt](image-url) | Image | ![Logo](logo.png) | Embedded image |
1. Use consistent heading levels for proper document structure
2. Add blank lines before and after headings for better readability
3. Indent nested lists with spaces for proper formatting
4. Use reference-style links for better maintainability in longer documents
5. Preview your Markdown while writing to ensure correct formatting
Note: Some Markdown processors might support additional syntax or have slight variations in how certain elements are rendered.