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)
<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.
> This is a blockquote
1. Item 1
- Item 1
| Syntax | Description |
The following table includes additional Doxicity-specific markdown syntaxes. You should only expect these to work with Doxicity.
:::details Toggle Me