Generated package

MkDocs favicon package. Ready to install.

Download the correct MkDocs favicon package, place every file in the right location, and follow the exact installation steps for this stack.

Stack-specific filesExact snippet locationsCopy-ready guide
Documentation9 files

MkDocs

For MkDocs. Files in docs/ are served from the site root; overrides/main.html adds the head snippet.

ZIP: favico-mkdocs-modern-package.zip

Folder: favico-mkdocs-modern-favicon/

  1. 1
    Download your favicon package.
    Download favico-mkdocs-modern-package.zip for MkDocs.
  2. 2
    Extract this package in your project.
    Extract it in your project root. The package contains:
    Package structure
    favico-mkdocs-modern-favicon/
├── docs/favicon.ico
├── docs/favicon.svg
├── docs/favicon-dark.svg
├── docs/favicon-96x96.png
├── docs/favicon-dark-96x96.png
├── docs/apple-touch-icon.png
├── docs/site.webmanifest
├── docs/web-app-manifest-192x192.png
└── docs/web-app-manifest-512x512.png
  3. 3
    Copy the favicon files to the correct location.
    Copy the generated files to docs/.
    Generated fileCopy toStatusPurpose
    favicon.icodocs/favicon.icoOptionalOptional classic browser fallback file. Keep it when useful, but do not link it by default in modern light/dark favicon snippets.
    favicon.svgdocs/favicon.svgRequiredLight-mode SVG favicon for modern browsers.
    favicon-dark.svgdocs/favicon-dark.svgOptionalDark-mode SVG favicon used with prefers-color-scheme: dark.
    favicon-96x96.pngdocs/favicon-96x96.pngRequiredLight-mode PNG fallback favicon.
    favicon-dark-96x96.pngdocs/favicon-dark-96x96.pngOptionalDark-mode PNG fallback favicon.
    apple-touch-icon.pngdocs/apple-touch-icon.pngRequirediPhone/iPad home screen icon.
    site.webmanifestdocs/site.webmanifestRequiredWeb app manifest containing app metadata and PWA icon references.
    web-app-manifest-192x192.pngdocs/web-app-manifest-192x192.pngRequired192×192 Android/PWA icon referenced by the web app manifest.
    web-app-manifest-512x512.pngdocs/web-app-manifest-512x512.pngRequired512×512 Android/PWA icon referenced by the web app manifest.
  4. 4
    Add the config snippet in mkdocs.yml.
    mkdocs.yml
    theme:
  name: mkdocs
  custom_dir: overrides
  5. 5
    Insert the favicon/head snippet in overrides/main.html inside {% block extrahead %}.
    overrides/main.html inside {% block extrahead %}
    {% extends "base.html" %}

{% block extrahead %}
<meta name="color-scheme" content="light dark">

<link rel="icon" type="image/svg+xml" href="/favicon.svg?v=10" media="(prefers-color-scheme: light)">
<link rel="icon" type="image/svg+xml" href="/favicon-dark.svg?v=10" media="(prefers-color-scheme: dark)">
<link rel="icon" type="image/png" sizes="96x96" href="/favicon-96x96.png?v=10" media="(prefers-color-scheme: light)">
<link rel="icon" type="image/png" sizes="96x96" href="/favicon-dark-96x96.png?v=10" media="(prefers-color-scheme: dark)">
<link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png?v=10">
<link rel="manifest" href="/site.webmanifest?v=10">
{% endblock %}
  6. 6
    Why this setup works.
    • MkDocs serves files from docs/ at the site root.
    • The overrides template injects the full modern favicon setup into the page head.

  7. Support Favico Studio

    Satisfied with the result?

    If Favico Studio helped you create your favicon faster, you can support the creator and help keep this tool free, fast, and available for everyone.

    ♥Support the creator→
  8. 7
    Start your app and verify the favicon URLs.
    Run command
    mkdocs serve
    Verify URLs
    http://127.0.0.1:8000/favicon.svg
http://127.0.0.1:8000/site.webmanifest
  9. 8
    Common mistakes to avoid.

    Using only theme.favicon

    Wrong: theme.favicon: img/favicon.ico

    Correct: Use overrides/main.html with the full head snippet

    theme.favicon alone cannot provide complete SVG/PNG light/dark favicon support.

  10. 9
    Final checklist.
    ✓ Correct stack selected.
    ✓ Correct package downloaded and extracted.
    ✓ Files copied to the exact folder shown in this guide.
    ✓ Config snippet added only when this stack requires it.
    ✓ Head/favicon snippet added to the exact head location shown in this guide.
    ✓ No /public/ or /static/ URL is used unless the framework explicitly requires it.
    ✓ favicon.ico is kept as fallback only, not actively linked as the main favicon.
    ✓ favicon.svg loads directly.
    ✓ favicon-dark.svg loads directly.
    ✓ site.webmanifest loads directly.
    ✓ Manifest icon PNG files load directly.
    ✓ Browser cache cleared and Favico Studio checker passes.