Icons¶
Replace individual toolbar or page-action icons with image files. Values are
paths relative to docs_dir or image URLs, not Material icon-library names.
theme:
name: pixel-lab
icon:
repo: assets/icons/repo.svg
search: assets/icons/search.svg
menu: assets/icons/menu.svg
close: assets/icons/close.svg
sites: assets/icons/sites.svg
dropdown: assets/icons/chevron.svg
view: assets/icons/source.svg
edit: assets/icons/edit.svg
For example, assets/icons/edit.svg belongs at
docs/assets/icons/edit.svg. Use only the keys you want to replace.
Set icons under theme.icon. A null value keeps the built-in artwork.
Toolbar icons¶
| Parameter | Default | Effect |
|---|---|---|
icon.repo |
null (Git branch) |
Replaces the repository button artwork |
icon.search |
null (magnifying glass) |
Replaces the search button artwork |
icon.menu |
null (menu) |
Replaces the mobile navigation open icon |
icon.close |
null (close) |
Replaces the mobile navigation close icon |
icon.sites |
null (pixel grid) |
Replaces the related-sites button artwork |
icon.dropdown |
null (down arrow) |
Replaces the dropdown arrow; remains omitted on compact screens |
SVG is recommended; PNG and other browser-supported image formats also work. Toolbar artwork preserves its original colors and fits a 14 × 14 px slot.
The button—not the artwork—provides the background, highlight, lift, and shadow. Changing an icon doesn't enable its feature or change its accessible label.
Page icons¶
| Parameter | Default | Effect |
|---|---|---|
icon.view |
null (code brackets) |
Replaces the View source artwork beside the title |
icon.edit |
null (pen nib) |
Replaces the Edit this page artwork beside the title |
Configure destinations and visibility in Source and edit links.
Source and edit icons use the image's alpha channel as a mask. Use artwork
with a transparent background: an opaque white rectangle becomes a filled
rectangle, not empty space. Custom icons receive a black silhouette and a
matching accent_dark_color hover/focus shadow, rather than the original
image colors.
Remote mask images must allow cross-origin loading (CORS). Local assets avoid that dependency. These image and mask styles work without JavaScript.
For sizing or mask problems, see Troubleshooting.
Other artwork¶
- Heading permalinks use the built-in
link icon or Python-Markdown's
toc.permalinktext, nottheme.icon. - Related-site items use their own
iconandicon_hoverproperties. - The site-name/TM artwork and navigation markers aren't
theme.iconoptions.