Summary

The summary provides an overview of your page's content and structure. When enabled, it shows on the right side of the page and allows users to quickly navigate to different sections. Elements shown in the summary are markdown headings (H1-H6).

The summary is enabled or disabled in the frontmatter of your .mq file using the summary property. More on that in the frontmatter documentation.

H1

H2

H3

H4

H5
H6
# H1
## H2
### H3
#### H4
##### H5
###### H6

The summary switches from one section to the next based on the scroll position of the page. More specifically, when scrolling a heading past the middle of the screen, the summary will switch to the next section. When you reach the end of the page, the summary will switch to the last section regardless of the scroll position. A dotted line appears to show the cutoff point on this page to showcase this behaviour.

Hiding headings from the summary

If you want to use a heading without it appearing in the summary, you can add a * symbol before it:

This heading will not appear in the summary

#* This heading will not appear in the summary

You can also use the * syntax with alternate heading styles:

Heading level 1

Heading level 2

Heading level 1
===============*
Heading level 2
---------------*