PIXEL LAB
GitHub

Branding

Site name

Set MkDocs' top-level site_name in mkdocs.yml:

site_name: My documentation

Pixel Lab displays it in the header with a decorative pixel TM badge. On compact screens the name stays on one line and truncates when space runs out.

Parameter Default Effect
site_name (MkDocs) Required; no default Header name and site-wide browser-title branding

For browser-title and description defaults, see Page metadata.

Favicon

The theme includes a favicon. Replace it with an SVG or PNG inside your docs directory:

theme:
  name: pixel-lab
  favicon: assets/favicon.svg

For this example, put the file at docs/assets/favicon.svg. The path is relative to docs_dir, not the repository root.

Parameter Default Effect
favicon assets/favicon.png Browser tab icon; custom paths are relative to docs_dir

Add footer text with theme.footer_text:

theme:
  name: pixel-lab
  footer_text: Build something useful
Parameter Default Effect
footer_text "" Optional text before the built-in attribution

Related-site links and a configured privacy link can also appear in the footer.

Further customization

Style the header and footer with these theme settings:

Parameter Default Effect
header_background Leaf green · #4caf50 Header fill
accent_foreground_color Near-black · #101410 Header site name and TM text
accent_color Leaf green · #4caf50 TM artwork accent
accent_dark_color Dark green · #287c35 TM artwork's darker accent
border_color Near-black · #101410 Footer's top divider
muted_text_color Gray-green · #5f665d Footer attribution text

See Common attributes.