Sign Up

Markdown Support

Doctave supports the CommonMark spec, along with some common extensions. Here is a list of features along with examples.

Headings

All heading types are supported.

// Underline style
H1
==

// Hash style
# H1
## H2
### H3
#### H4
##### H5
###### H6

Note that headings smaller than H3 won't show up on the right-side navigation.

Emphasis

Both **bold**, _italics_, and ~~strikethrough~~ are supported.

Both bold, italics, and ~~strikethrough~~ are supported.

Lists

Unordered lists

* Mary
* Had
* A little
    * Lamb
  • Mary
  • Had
  • A little
    • Lamb

Ordered lists

1. Mary
2. Had
3. A little
    1. Lamb
  1. Mary
  2. Had
  3. A little
    1. Lamb

Links

[Doctave](https://doctave.com)

Doctave

Images

![A random image](https://picsum.photos/600/400)

A random image

Quotes

> It's true, because it's a quote

It's true, because it's a quote

Code

Inline

Use `backticks for inline code snippets`.

Use backticks for inline code snippets.

Block

Either use three backticks

```
For().your().code()
```

To achieve:

For().your().code()

Doctave doesn't support indented code blocks.
This is so that we're able to support indenting Markdown content inside components.

You can also add a language and a title to your code blocks:

```javascript title="JavaScript example"
For().your().code()
```

This will enable syntax highlighting, and add a header for the code block.

JavaScript example
For().your().code()

Task Lists

- [ ] This is a list of to-dos
- [x] This is a completed item
- [ ] This is an uncompleted item
  • This is a list of to-dos
  • This is a completed item
  • This is an uncompleted item

Tables

This is a heading              | This is another heading  |
-------------------------------|--------------------------|
This is content for a columns  | This is **bold**         |
You can have more rows         | And more columns         |
This is a headingThis is another heading
This is content for a columnsThis is bold
You can have more rowsAnd more columns

Was this page helpful?