Skip to content
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.

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

Allow non-GOV.UK favicon and opengraph assets #387

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kr8n3r
Copy link
Contributor

@kr8n3r kr8n3r commented Jan 21, 2025

Fixes: #347

We already provide a way to non display the crown next to the service name by setting show_govuk_logo: false in config/tech-docs.yml. This is used by external users such as MOJ.

This work extends the usage of that setting enabled custom favicon and opengraph image insted of the default Crown. It's limited to just the favicon.ico, favicon.svg and opengraph-image.png, but this should suffice.

Users need to create those assets and place them in their source/images folder.

Before

Screenshot 2025-01-21 at 13 49 27

After

Screenshot 2025-01-21 at 13 48 43

@kr8n3r kr8n3r force-pushed the optional-non-govuk-favicon branch from 6801fa3 to 75cc5b0 Compare January 21, 2025 13:52
@kr8n3r kr8n3r changed the title Allow non-GOV.UK favicon and opengraph assets WIP: Allow non-GOV.UK favicon and opengraph assets Jan 21, 2025
Copy link
Contributor

@marcotranchino marcotranchino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lovely stuff! 👌

@kr8n3r kr8n3r force-pushed the optional-non-govuk-favicon branch from 75cc5b0 to 5182727 Compare January 21, 2025 14:10
Fixes: #347

We already provide a way to non display the crown next to the service name by setting `show_govuk_logo: false` in config/tech-docs.yml. This is used by external users such as [MOJ](https://user-guide.modernisation-platform.service.justice.gov.uk).

This work extends the usage of that setting enabled custom favicon and opengraph image insted of the default Crown.
It's limited to just the `favicon.ico`, `favicon.svg` and `opengraph-image.png`, but this should suffice.

Users need to create those assets and place them in their `source/images` folder.
@kr8n3r kr8n3r force-pushed the optional-non-govuk-favicon branch from 5182727 to 9d88ddd Compare January 21, 2025 14:42
@kr8n3r kr8n3r changed the title WIP: Allow non-GOV.UK favicon and opengraph assets Allow non-GOV.UK favicon and opengraph assets Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Crown favicon optional
2 participants