Skip to content

Markdown Guide

Learn the basics of writing documentation with Markdown.

Headings

Create headings with #:

# H1 Heading
## H2 Heading
### H3 Heading
#### H4 Heading

Text Formatting

Bold and Italic

**bold text**
*italic text*
***bold and italic***

Inline Code

Use backticks for inline code:

This is `inline code`.

Lists

Unordered Lists

- Item 1
- Item 2
  - Nested item
  - Another nested item
- Item 3

Ordered Lists

1. First item
2. Second item
3. Third item
[Link to another page](/docs/guides/search)
[Visit GitHub](https://github.com)

Images

![Alt text](/images/screenshot.png)

Code Blocks

Basic Code Block

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

With Title

```javascript title="app.js"
function greet(name) {
  return `Hello, ${name}!`;
}
```

Line Highlighting

```javascript {2-3}
function example() {
  const a = 1;
  const b = 2;
  return a + b;
}
```

Blockquotes

> This is a blockquote.
> It can span multiple lines.

Tables

| Column 1 | Column 2 | Column 3 |
|----------|----------|----------|
| Value 1  | Value 2  | Value 3  |
| Value 4  | Value 5  | Value 6  |

Horizontal Rules

---

Task Lists

- [x] Completed task
- [ ] Incomplete task
- [ ] Another task

Footnotes

Here's a sentence with a footnote[^1].

[^1]: This is the footnote content.

URLs become links automatically:

https://example.com