Skip to main content

Easily add shortcut icons to any wagtail site.

Project description

Wagtail Favicon

Easily add shortcut icons to any wagtail site. Upload a .png image from a wagtail settings page and wagtail-favicon will resize it and add provide markup to your pages via a template tag.

Version 0.3.0 is for Wagtail versions 3+.

Installation & Setup

Install with pip

pip install wagtail-favicon


poetry add wagtail-favicon

Add to Django installed apps

    'wagtail.contrib.settings'  # <-- ensure you have wagtail settings loaded 

Add routes to app.urls

from wagtail_favicon.urls import urls as favicon_urls

urlpatterns += [
    path('documents/', include(wagtaildocs_urls)),
    path('search/', search, name='search'),
    path('', include(wagtail_urls)),

    path('', include(favicon_urls)),  # <------ add urls to existing urls

Once you've completed setup you will now be able to access the folloing urls:

Add template tag to tag in templates/base.html

{% load favicon_tags %}
        {% favicon_meta %}

Edit Settings

Go to Wagtail Admin >> Settings >> Favicon

Configure settings

For best results use a transparent png at 1024 x 1024.
Ideally pre optimised with a tool like


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wagtail_favicon-0.3.0.tar.gz (4.9 kB view hashes)

Uploaded Source

Built Distribution

wagtail_favicon-0.3.0-py2.py3-none-any.whl (7.4 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page