In order to provide a documentation consumption experience that is consistent, beautiful, and joyful to use, we have adopted the following style guide that is to be used throughout all documentation hubs.
Follow your gut
Keep in mind that this document is merely a guide. If something doesn’t feel right or look right with the styling here, feel free to deviate.
Titles and headers
Text Type |
Formatting |
Example |
Page titles |
Title case |
Intro to the Style Guide |
H1, H2, and H3 headers |
Usually none (see below) |
Titles and headers |
H1, H2, and H3 headers |
Title case when text is a noun |
Track End Plate |
Paragraphs
Text Type |
Formatting |
Example |
Paragraph text |
None |
Sounds good, let’s go! |
Part name |
Bolded when used the first time in a paragraph |
Insert four tee nuts into the extrusion. Then slide the tee nuts into position. |
Tables
Text Type |
Formatting |
Example |
Table column headers |
Title case |
Text Type |
Table row headers |
Bold, title case |
Surface Treatment |
Table cell text |
None |
Clear anodized |
Table row or cell used as a subheading |
Bold |
All versions |
Total |
Bold |
$2,345.67 |
Grand total |
Bold, uppercase |
GRAND TOTAL |
Callouts
Text Type |
Formatting |
Example |
Callout title |
None (will be automatically bolded) |
Follow your gut |
Callout text |
None |
And your
|
Images
- Photos and images that are full-bleed should be displayed without the Border option
- Images that have transparent or white backgrounds should be displayed with the Border option.
- All photos and images should be displayed using the 100% width size option, with the following exceptions:
- Portrait photos and images should be displayed using the Smart Fit size option.
- Small photos and images (less than 600 x 400) should be displayed using the Original size option.