Skip to main content

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](this.html) to <a href="this.html">this<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.

Feature Markdown
Heading
# H1
## H2
### H3
Bold
**bold text**
Italic
*italicized text*
Blockquote
> This is a blockquote
Ordered List
1. Item 1
2. Item 2
3. Item 3
Unordered List
- Item 1
- Item 2
- Item 3
Code (inline)
`inline code`
Code (block)
```
code block
```
Horizontal Rule
---
Link
[link text](https://example.com/)
Image
![alt text](image.jpg)
Table
| 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.

Feature Markdown
Highlight
==mark==
Insert
++insert++
Delete/strike
~~delete~~
Tip callout
:::tip
This is a tip!
:::
Warning callout
:::warning
This is a warning!
:::
Danger callout
:::danger
This is something dangerous!
:::
Aside
:::aside
This will be rendered on the side
:::
Details
:::details Toggle Me
This content is expandable
:::
Cover
:::cover
This is a cover section that will expand the full width of the page
:::