Content

Markdown Syntax

An overview of Markdown, how it works, what you can do with it and how it is styled for Refine UI.

To create a heading, add number signs (#) in front of a word or phrase. The number of number signs you use should correspond to the heading level. For example, to create a heading level three (<h3>), use three number signs (e.g., ### My Header).

MarkdownOutput
# Heading 1!!!

Heading 1

## Heading 2

Heading 2

### Heading 3

Heading 3

#### Heading 4

Heading 4

##### Heading 5
Heading 5
###### Heading 6
Heading 6

Alternate Syntax

Alternatively, on the line below the text, add any number of == characters for heading level 1 or -- characters for heading level 2.

MarkdownOutput
Heading 1
===============

Heading 1

Heading 2
---------------

Heading 2

Best Practices

Markdown applications don't agree on how to handle a missing space between the number signs (#) and the heading name. For compatibility, always put a space between the number signs and the heading name.

Do
# Heading Title
Don't
#Heading Title

  1. Never use this. The top-level heading is generated automatically.