The following are examples of standard atx-style headers.
This is an atx-style H1
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Vel pretium lectus quam id leo in. Convallis tellus id interdum velit laoreet id donec.
This is an an atx-style H2
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Vel pretium lectus quam id leo in. Convallis tellus id interdum velit laoreet id donec.
This is an an atx-style H6
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Vel pretium lectus quam id leo in. Convallis tellus id interdum velit laoreet id donec.
The following are examples of closed atx-style headers.
This is a closed atx-style H1
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Vel pretium lectus quam id leo in. Convallis tellus id interdum velit laoreet id donec.
This is a closed atx-style H2
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Vel pretium lectus quam id leo in. Convallis tellus id interdum velit laoreet id donec.
This is a closed atx-style H6
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Vel pretium lectus quam id leo in. Convallis tellus id interdum velit laoreet id donec.
The following are examples of setext-style headers.
This is a setext-style H1
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Vel pretium lectus quam id leo in. Convallis tellus id interdum velit laoreet id donec.
This is also a setext-style H1
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Vel pretium lectus quam id leo in. Convallis tellus id interdum velit laoreet id donec.
This is a setext-style H2
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Vel pretium lectus quam id leo in. Convallis tellus id interdum velit laoreet id donec.
This is also a setext-style H2
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Vel pretium lectus quam id leo in. Convallis tellus id interdum velit laoreet id donec.
The following are examples of header IDs.
Automatically generated IDs
DevSite's Markdown compiler auto-generates an HTML id attribute for every
header. The autogenerated ID for this header is automatically_generated_ids.
Specify your own ID
Add a custom attribute at the end of the Markdown header to override the default
id. The header ID for this section is specify-id.
Unicode characters in headers 🥳
Unicode may also be added in headers for greater ID specification. The
autogenerated ID for this header is unicode_characters_in_headers_🥳.
This header doesn't show up in the TOC
The reason this header doesn't show up in the TOC is because it specifies the
custom attribute {:.hide-from-toc}.