UnmarkdownDocs

Markdown Basics

The core Markdown syntax you need to write and publish documents with Unmarkdown.

Note
Unmarkdown is based on GitHub Flavored Markdown (GFM) via remark-gfm. This means tables, strikethrough, task lists, and autolinks are all supported out of the box.

Headings

Use the # prefix for headings. Headings structure your document and are used to generate the table of contents on published pages.

markdown
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
Tip
Use heading level 1 sparingly. Most documents should have a single H1 as the title, with H2 and H3 for sections and subsections.

Paragraphs and Line Breaks

Paragraphs are separated by a blank line. To create a line break within a paragraph, end the line with two spaces or use a backslash.

markdown
This is the first paragraph.

This is the second paragraph.

This line has a break\
right here.
Important
Unmarkdown uses remarkBreaks by default, which means single newlines in your source will render as line breaks (<br>). This differs from standard Markdown where single newlines are ignored. Keep this in mind when pasting content from other editors.

Emphasis

Use asterisks or underscores for italic and bold text. Combine them for bold italic.

markdown
*italic text* or _italic text_
**bold text** or __bold text__
***bold and italic*** or ___bold and italic___

Links use square brackets for the label and parentheses for the URL. You can optionally add a title that appears on hover.

markdown
[Visit Unmarkdown](https://unmarkdown.com)
[Link with title](https://unmarkdown.com "Unmarkdown homepage")

For documents with many links, reference-style links keep the text readable. Define the URL separately, then reference it by label.

markdown
Read the [quickstart guide][quickstart] or browse the [API reference][api].

[quickstart]: https://docs.unmarkdown.com/docs/quickstart
[api]: https://docs.unmarkdown.com/docs/api/overview

Bare URLs are automatically converted to clickable links via GFM autolink detection.

markdown
Visit https://unmarkdown.com for more information.

Images

Images use the same syntax as links, with an exclamation mark prefix. The text in brackets becomes the alt text.

markdown
![Screenshot of the editor](https://example.com/screenshot.png)
![Logo](https://example.com/logo.png "Company logo")

Lists

Use -, *, or + for unordered lists, and numbers followed by a period for ordered lists.

markdown
- First item
- Second item
- Third item

1. Step one
2. Step two
3. Step three

Nested Lists

Indent with two spaces to nest lists. You can mix ordered and unordered lists.

markdown
1. First section
   - Detail A
   - Detail B
2. Second section
   1. Sub-step one
   2. Sub-step two
      - Deeper nested item
3. Third section

Task Lists

Task lists (checkboxes) are supported for tracking progress or creating checklists.

markdown
- [x] Completed task
- [ ] Pending task
- [ ] Another pending task

Blockquotes

Prefix lines with > to create blockquotes. Blockquotes can be nested and can contain other Markdown elements.

markdown
> This is a blockquote.
>
> It can span multiple paragraphs.

> > Nested blockquotes use double angle brackets.
> > They create a deeper indentation level.

Tables

Tables use pipe syntax with a separator row. Use colons in the separator to control column alignment.

markdown
| Feature     | Free   | Pro       |
|:------------|:------:|----------:|
| Documents   | 3      | Unlimited |
| Templates   | 8      | 62        |
| API calls   | 1,000  | 10,000    |

Alignment is set per column in the separator row: :--- for left, :---: for center, ---: for right. Left alignment is the default.

Horizontal Rules

Create a horizontal rule (divider) with three or more hyphens, asterisks, or underscores on their own line.

markdown
---

***

___

Escape Characters

Use a backslash to display characters that would otherwise be interpreted as Markdown syntax.

markdown
\*Not italic\*
\# Not a heading
\[Not a link\](https://example.com)
Price: \$9.99
Pipe in table: \|

Characters that can be escaped: \\ * _ # [ ] ( ) | ` ~ >

HTML Entities

Standard HTML entities are supported for special characters that are difficult to type directly.

markdown
&amp; renders as &
&lt; renders as <
&gt; renders as >
&nbsp; renders as a non-breaking space
&copy; renders as ©
&mdash; renders as —