Authoring

If you’re new to markdown, this page will bring you up to speed with what you need to know to get started.

Markdown is a markup syntax that turns text into HTML. It’s a convenient way to go from this:

_Italics_
**Bold**
[Link](page.html)

          

          
        

to this:

<em>Italics</em>
<strong>Bold</strong>
<a href="page.html">Link</a>

          

          
        

…without having to type all those quotes and brackets. It’s built to be as simple as possible — most users can pick up the basics in just a few minutes.

Doxicity adheres to the CommonMark spec, but there are a few additional syntaxes that are really helpful when writing docs.

Markdown Cheat Sheet

The following table includes a non-exhaustive list of CommonMark syntaxes that are supported. You can expect these to work in Doxicity and most places markdown is supported.

# H1
## H2
### H3

**bold text**

_italicized text_

> This is a blockquote

1. Item 1
2. Item 2
3. Item 3

- Item 1
- Item 2
- Item 3

`inline code`

```
code block
```

---

[link text](https://example.com/)

![alt text](image.jpg)

| Syntax      | Description |
| ----------- | ----------- |
| Header      | Title       |
| Paragraph   | Text        |

Doxicity-flavored Markdown

The following table includes additional Doxicity-specific markdown syntaxes. You should only expect these to work with Doxicity.

==mark==

++insert++

~~delete~~

:::tip
This is a tip!
:::

:::warning
This is a warning!
:::

:::danger
This is something dangerous!
:::

:::aside
This will be rendered on the side
:::

:::details Toggle Me
This content is expandable
:::