Skip to content

Commit 6801fa3

Browse files
committed
Allow non-GOV.UK favicon and opengraph assets
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.
1 parent d41b0d5 commit 6801fa3

File tree

2 files changed

+15
-6
lines changed

2 files changed

+15
-6
lines changed

lib/govuk_tech_docs/meta_tags.rb

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,11 @@ def canonical_url
4848
attr_reader :config, :current_page
4949

5050
def page_image
51-
"#{host}/assets/govuk/assets/images/govuk-opengraph-image.png"
51+
if config[:tech_docs][:show_govuk_logo]
52+
"#{host}/assets/govuk/assets/images/govuk-opengraph-image.png"
53+
else
54+
"#{host}/images/opengraph-image.png"
55+
end
5256
end
5357

5458
def site_name

lib/source/layouts/core.erb

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,16 @@
1010
<%= stylesheet_link_tag :manifest %>
1111

1212
<link rel="canonical" href="<%= meta_tags.canonical_url %>">
13-
<link rel="icon" sizes="48x48" href="/assets/govuk/assets/images/favicon.ico">
14-
<link rel="icon" sizes="any" href="/assets/govuk/assets/images/favicon.svg" type="image/svg+xml">
15-
<link rel="mask-icon" href="/assets/govuk/assets/images/govuk-icon-mask.svg" color="#0b0c0c">
16-
<link rel="apple-touch-icon" href="/assets/govuk/assets/images/govuk-icon-180.png">
17-
<link rel="manifest" href="/assets/govuk/assets/manifest.json">
13+
<% if config[:tech_docs][:show_govuk_logo] %>
14+
<link rel="icon" sizes="48x48" href="/assets/govuk/assets/images/favicon.ico">
15+
<link rel="icon" sizes="any" href="/assets/govuk/assets/images/favicon.svg" type="image/svg+xml">
16+
<link rel="mask-icon" href="/assets/govuk/assets/images/govuk-icon-mask.svg" color="#0b0c0c">
17+
<link rel="apple-touch-icon" href="/assets/govuk/assets/images/govuk-icon-180.png">
18+
<link rel="manifest" href="/assets/govuk/assets/manifest.json">
19+
<% else %>
20+
<link rel="icon" sizes="48x48" href="/mages/favicon.ico">
21+
<link rel="icon" sizes="any" href="/images/favicon.svg" type="image/svg+xml">
22+
<% end %>
1823

1924
<% meta_tags.tags.each do |name, content| %>
2025
<%= tag :meta, name: name, content: content %>

0 commit comments

Comments
 (0)