Skip to content

Assets Directory

This directory contains static assets for the MkDocs documentation site.

Logo Setup

To add a logo that links to the home page:

  1. Add your logo file to this directory:
  2. Recommended name: logo.png or logo.svg
  3. Recommended size: 200x50px (or similar aspect ratio)

  4. Format: PNG (with transparency) or SVG (preferred)

  5. Logo specifications:

  6. PNG: Use transparent background, max height 50px
  7. SVG: Scalable vector format (recommended)

  8. File size: Keep under 100KB for fast loading

  9. Update mkdocs.yml: 

    theme:
  name: material
  site_logo: assets/logo.png  # or assets/logo.svg

  10. Rebuild documentation: 

    mkdocs build

Favicon Setup

To add a favicon:

  1. Add favicon file to this directory:
  2. Name: favicon.ico or favicon.png

  3. Size: 32x32px or 16x16px

  4. Update mkdocs.yml: 

    theme:
  name: material
  favicon: assets/favicon.ico

Current Files

  • README.md - This file (instructions)

Notes

  • All files in this directory will be copied to the built documentation site
  • Use relative paths in mkdocs.yml (e.g., assets/logo.png)
  • Logo will automatically link to the home page when clicked