Allow non-GOV.UK favicon and opengraph assets #387
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kr8n3r
force-pushed
the
optional-non-govuk-favicon
branch
from
6801fa3 to
75cc5b0
Compare
kr8n3r
changed the title
kr8n3r
force-pushed
the
optional-non-govuk-favicon
branch
2 times, most recently
from
5182727 to
9d88ddd
Compare
kr8n3r
changed the title
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
force-pushed
the
optional-non-govuk-favicon
branch
from
9d88ddd to
c7ade1d
Compare
kr8n3r
added a commit
that referenced
this pull request
Feb 26, 2025
## 4.2.0 ## New features - [Allow non-GOV.UK favicon and opengraph assets](#387) To use a non-crown assets, you need to - add `favicon.ico`, `favicon.svg` and `opengraph-image.png` to your `source/images` folder. - set `show_govuk_logo: false`
Merged
maverickvi
pushed a commit
to hmrc/tech-docs-gem
that referenced
this pull request
Apr 8, 2025
## 4.2.0 ## New features - [Allow non-GOV.UK favicon and opengraph assets](alphagov#387) To use a non-crown assets, you need to - add `favicon.ico`, `favicon.svg` and `opengraph-image.png` to your `source/images` folder. - set `show_govuk_logo: false`
tombye
added a commit
to alphagov/notifications-tech-docs
that referenced
this pull request
Apr 30, 2025
This bumps the tech docs gem to v4.3.0 which brings in [v5.9.0 of GOVUK Frontend](alphagov/tech-docs-gem#390). This also includes the following changes from the gem: - [Fix: Update Rack::File to Rack::Files in test specs](alphagov/tech-docs-gem#394) - [Fix: Use the service link as the start of the path to the favicon images](alphagov/tech-docs-gem#391) - [Allow non-GOV.UK favicon and opengraph assets](alphagov/tech-docs-gem#387) The last change, sets favicon and opengraph images to be sourced from `source/images` so adds defaults for any GOV.UK tech docs. This also bumps all the dependencies to the latest version within their semver range. Check the Gemfile.lock for a full list of these bumps.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: #347
We already provide a way to non display the crown next to the service name by setting
show_govuk_logo: falsein 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.svgandopengraph-image.png, but this should suffice.Users need to create those assets and place them in their
source/imagesfolder.Before
After