Previewing documentation formatting
Last updated: November 21, 2022
This page contains a variety of formatting options for our Help Center. Preview their appearance below to help you craft your documentation.
Types of headers
This is an H2 header
H2 headers are great candidates for the largest topics in your documentation. They are our largest header type used (besides the title of a help page), and appear underlined and bolded. All H2s are linked.
This is an H3 header
H3 headers are great as primary sub-sections below an H2. They are not underlined but are larger than normal body text and bolded. Just like H2s, all H3 headers are linked.
This is an H4 header
H4 headers are hardly ever used because they appear about the same size as our normal body text. However, they are available, and like all other headers, are linked.
Collapsed sections
This is a collapsed H2 header
Appearing exactly like normal H2s, this collapsed H2 header is a great way to indicate a large topic in your documentation, but hides the body content away, which can make the page appear cleaner and more streamlined. Consider using a collapsed H2 if the body underneath the H2 header is very long and bulky.
This is a linkable caret section
beep borp
This is a caret section
beep borp
Note: This is a callout. You can use the red callout to highlight very important alerts.
Note: This is a callout. You can use the orange callout to highlight important alerts.
Note: This is a callout. You can use the blue callout to highlight relevant notes.
Tip: This is a callout. You can use the green callout to highlight tips and tricks.