Text and lists¶
Headings, basic text, links, quotations, and lists use standard Markdown. No extra extension is required.
Headings¶
Use one H1 (#) for the page title, H2 (##) for sections, and H3 (###)
for subsections. Keep heading levels in order rather than choosing a level
for its visual size.
For site-wide anchor-link visibility and appearance, see Heading permalinks.
Emphasis and inline code¶
Use bold for emphasis, italics for a term, and inline_code for short
identifiers. Link to a related page with descriptive text.
Use **bold** for emphasis, *italics* for a term, and `inline_code` for short
identifiers. Link to a [related page](tabs.md) with descriptive text.
Lists¶
- Configure the theme once.
- Write content in Markdown.
- Keep related guidance together.
- Show the result next to its source.
- Configure the theme once.
- Write content in Markdown.
- Keep related guidance together.
- Show the result next to its source.
- Install Pixel Lab.
- Select the theme.
- Preview the site.
Quotations¶
Documentation is part of the product.
For predefined semantic callouts, use Alerts. For a custom title, use Admonitions.
Customization¶
These theme settings customize text throughout the site:
theme:
name: pixel-lab
text_color: "#182018"
muted_text_color: "#5f665d"
accent_color: "#4caf50"
accent_dark_color: "#287c35"
surface_alt_color: "#e8e4cf"
inline_code_border_color: "rgba(40, 124, 53, 0.45)"
| Parameter | Default | Effect |
|---|---|---|
text_color |
Dark green-gray · #182018 |
Body text and hovered links |
muted_text_color |
Gray-green · #5f665d |
Quotation text |
accent_color |
Leaf green · #4caf50 |
Quotation's left rail |
accent_dark_color |
Dark green · #287c35 |
Link text |
surface_alt_color |
Pale khaki · #e8e4cf |
Inline code background |
inline_code_border_color |
Dark green at 45% · rgba(40, 124, 53, 0.45) |
Inline code border |
See Common attributes.
Component-wide overrides¶
To change every ordinary quotation's rail, add this to your custom stylesheet:
Scoped overrides¶
Wrap each selected quotation, following Scope selected instances:
Add the scoped rule to your stylesheet: