Skip to content

Add dark mode favicons and template to overwrite favicons #1587

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Add dark mode favicons and template to overwrite favicons #1587

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e910493
add SVG favicon
dpgraham4401 Nov 7, 2025
500a7ab
replace existing PNG with PNG that doesn't have the fringe effects
dpgraham4401 Nov 7, 2025
89a134d
replace PNG favicon in docs with SVG favicon
dpgraham4401 Nov 7, 2025
fe5c474
replace usage of favicon.png with favicon.svg, with the PNG still as …
dpgraham4401 Nov 7, 2025
3cc2bdf
use a separate django template for the favicons to allow people to ov…
dpgraham4401 Nov 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/docs/guides/api-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,3 +115,19 @@ class MyDocsViewer(DocsBase):
api = NinjaAPI(docs=MyDocsViewer())

```

## Using a custom favicon

The django-ninja OpenAPI docs contain a default favicon, the ninja star.
To use your own, overwrite the `ninja/favicon.html` django template.

```html
<!-- templates/ninja/favicons.html -->
{% load static %}

{% block favicons %}
<link rel="icon" type="image/png" href="{% static 'path/to/your/favicon.png' %}">
{% endblock %}
```

for more information, see the [Django documentation on overriding templates](https://docs.djangoproject.com/en/5.2/howto/overriding-templates/).
Binary file removed docs/docs/img/favicon.png
View file
Open in desktop
Binary file not shown.
26 changes: 26 additions & 0 deletions docs/docs/img/favicon.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ theme:
icon: material/weather-sunny
name: Switch to light mode
logo: img/docs-logo.png
favicon: img/favicon.png
favicon: img/favicon.svg
language: en
features:
- navigation.expand
Expand Down
Binary file modified ninja/static/ninja/favicon.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions ninja/static/ninja/favicon.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions ninja/templates/ninja/favicons.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{% load static %}

{% block favicons %}
<link rel="icon" href="{% static 'ninja/favicon.svg' %}" type="image/svg+xml">
<link rel="icon" href="{% static 'ninja/favicon.png' %}" type="image/png">
{% endblock %}
2 changes: 1 addition & 1 deletion ninja/templates/ninja/redoc.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!DOCTYPE html>
<html>
<head>
<link rel="shortcut icon" href="{% static 'ninja/favicon.png' %}">
{% include "ninja/favicons.html" %}
<title>{{ api.title }}</title>
<meta name="viewport" content="width=device-width, initial-scale=1" />
<style>
Expand Down
3 changes: 2 additions & 1 deletion ninja/templates/ninja/redoc_cdn.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<!DOCTYPE html>
<html>
<head>
<link rel="shortcut icon" href="https://django-ninja.dev/img/favicon.png">
<link rel="icon" href="https://django-ninja.dev/img/favicon.svg" type="image/svg+xml">
<link rel="icon" href="https://django-ninja.dev/img/favicon.png" type="image/png">
<title>{{ api.title }}</title>
<meta name="viewport" content="width=device-width, initial-scale=1" />
<style>
Expand Down
2 changes: 1 addition & 1 deletion ninja/templates/ninja/swagger.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html>
<head>
<link type="text/css" rel="stylesheet" href="{% static 'ninja/swagger-ui.css' %}">
<link rel="shortcut icon" href="{% static 'ninja/favicon.png' %}">
{% include "ninja/favicons.html" %}
<title>{{ api.title }}</title>
</head>
<body
Expand Down
3 changes: 2 additions & 1 deletion ninja/templates/ninja/swagger_cdn.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
<html>
<head>
<link type="text/css" rel="stylesheet" href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css">
<link rel="shortcut icon" href="https://django-ninja.dev/img/favicon.png">
<link rel="icon" href="https://django-ninja.dev/img/favicon.svg" type="image/svg+xml">
<link rel="icon" href="https://django-ninja.dev/img/favicon.png" type="image/png">
<title>{{ api.title }}</title>
</head>
<body>
Expand Down
Empty file added tests/demo_project/db.sqlite3
View file
Open in desktop
Empty file.