Markdown is a lightweight markup language with a plain text formatting syntax.

It is designed so that it can be converted to HTML and many other formats.

Markdown powers all of the written content in Basedoc projects. It is easy to work with on your computer, sync to GitHub, and publish to the web.

LLMs also love Markdown, so keeping your content in Markdown makes it easy to use around the internet, even outside the Basedoc platform.

Markdown files in your project can have either the .md or .mdx extension (if you want to insert components into your Markdown pages, you must use .mdx files).

Formatting text

Headers

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

Paragraphs

Separate paragraphs with a blank line.

This is a paragraph.

This is another paragraph.

To make single line breaks, add two spaces at the end of the line above.

This is a line with a single line break.  
This is another line.

This is a line with a single line break.
This is another line.

Bold text

**Bold text**

Bold text

Italic text

_Italic text_

Italic text

Links

[Link text](https://www.example.com)

Link text

[Link to the Config page](/config)

Link to the Config page

Lists

Ordered list:

1. List item 1
2. List item 2
3. List item 3

1. List item 1
2. List item 2
3. List item 3

Unordered list:

- List item 1
- List item 2
- List item 3

or

* List item 1
* List item 2
* List item 3

• List item 1
• List item 2
• List item 3

Images

![Image alt text](https://www.example.com/image.png)

Blockquotes

Add a > at the beginning of every line inside a blockquote.

> This is a blockquote.
>
> This is a second paragraph in the blockquote.

This is a blockquote.

This is a second paragraph in the blockquote.

Code blocks

```javascript
const example = "Hello, world!";
console.log(example);
```

```javascript hello-world.js
const example = "Hello, world!";
console.log(example);
```

const example = "Hello, world!";
console.log(example);

const example = "Hello, world!";
console.log(example);

Tables

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