Use headings to create a hierarchy for content.
Write all headings in sentence case.
Page titles should be formatted as extra large headings. Other headings should be formatted as large headings first, and then in decreasing size order.
Always use headings in decreasing size order; don't skip heading sizes or use headings when you should use paragraph text.
Extra large heading
Formatted example
Extra large heading
HTML code
<h1>Extra large heading</h1>
Markdown
# Extra large heading
Large heading
Formatted example
Large heading
HTML code
<h2>Large heading</h2>
Markdown
## Large heading
Medium heading
Formatted example
Medium heading
HTML code
<h3>Medium heading</h3>
Markdown
### Medium heading
Small heading
Formatted example
Small heading
HTML code
<h4>Small heading</h4>
Markdown
#### Small heading
Headings with captions
Sometimes you may need to make it clear that a page is part of a larger section or group. To do this, you can use a heading with a caption above it.
Extra large heading with caption
Formatted example
Extra large captionExtra large heading
HTML code
<span class="caption-xl">Extra large caption</span>
<h1>Extra large heading</h1>
Large heading with caption
Formatted example
Large captionLarge heading
HTML code
<span class="caption-lg">Large caption</span>
<h2>Large heading</h2>
Medium heading with caption
Formatted example
Medium captionMedium heading
HTML code
<span class="caption-md">Medium caption</span>
<h3>Medium heading</h3>
Override captions
You can override the default caption generated as part of the header in the page front matter.
Deactivate caption
To hide the caption, and only show the page heading, set caption
to false
.
Markdown
caption: false
Custom caption
To change the caption text, set caption
to any text string inside quotes.
Markdown
caption: "Custom caption"