diff --git a/docs/docs/guides/api-docs.md b/docs/docs/guides/api-docs.md index 114e895e3..fb4d5ecf7 100644 --- a/docs/docs/guides/api-docs.md +++ b/docs/docs/guides/api-docs.md @@ -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 + +{% load static %} + +{% block favicons %} + +{% endblock %} +``` + +for more information, see the [Django documentation on overriding templates](https://docs.djangoproject.com/en/5.2/howto/overriding-templates/). diff --git a/docs/docs/img/favicon.png b/docs/docs/img/favicon.png deleted file mode 100644 index f7045446b..000000000 Binary files a/docs/docs/img/favicon.png and /dev/null differ diff --git a/docs/docs/img/favicon.svg b/docs/docs/img/favicon.svg new file mode 100644 index 000000000..4279c04a9 --- /dev/null +++ b/docs/docs/img/favicon.svg @@ -0,0 +1,26 @@ + + + + + + diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 77d5fdcde..974a8f9ae 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -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 diff --git a/ninja/static/ninja/favicon.png b/ninja/static/ninja/favicon.png index f7045446b..5166b832e 100644 Binary files a/ninja/static/ninja/favicon.png and b/ninja/static/ninja/favicon.png differ diff --git a/ninja/static/ninja/favicon.svg b/ninja/static/ninja/favicon.svg new file mode 100644 index 000000000..4279c04a9 --- /dev/null +++ b/ninja/static/ninja/favicon.svg @@ -0,0 +1,26 @@ + + + + + + diff --git a/ninja/templates/ninja/favicons.html b/ninja/templates/ninja/favicons.html new file mode 100644 index 000000000..a4452f4b3 --- /dev/null +++ b/ninja/templates/ninja/favicons.html @@ -0,0 +1,6 @@ +{% load static %} + +{% block favicons %} + + +{% endblock %} \ No newline at end of file diff --git a/ninja/templates/ninja/redoc.html b/ninja/templates/ninja/redoc.html index 14c3ea449..bd86abaa9 100644 --- a/ninja/templates/ninja/redoc.html +++ b/ninja/templates/ninja/redoc.html @@ -2,7 +2,7 @@ - + {% include "ninja/favicons.html" %} {{ api.title }}