Skip to content

Commit

Permalink
Document opengraphImageUrl page template option
Browse files Browse the repository at this point in the history
Document the new `opengraphImageUrl` page template option, added in alphagov/govuk-frontend#2673.

Update the documentation for the `assetUrl` option to make it slightly more generic and remove the recommendation to override by adding another meta tag to the `head` block as users should use the new `opengraphImageUrl` instead.
  • Loading branch information
36degrees authored and owenatgov committed Aug 9, 2022
1 parent 69be51f commit 57572f4
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion src/styles/page-template/index.md.njk
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ To change the components that are included in the page template by default, set
<tr class="govuk-table__row">
<td class="govuk-table__cell">assetUrl</td>
<td class="govuk-table__cell">Variable</td>
<td class="govuk-table__cell">Set the domain for the Open Graph meta tag image asset. If you need to use both your own domain and your own image path and filename, add <code>&lt;meta property="og:image" content="YOUR-ABSOLUTE-URL"&gt;</code> inside the <code>head</code> block instead of using `assetUrl`.</td>
<td class="govuk-table__cell">Set the domain for assets where an absolute URL is required, for example the Open Graph image.</td>
</tr>

<tr class="govuk-table__row">
Expand Down Expand Up @@ -241,6 +241,12 @@ To change the components that are included in the page template by default, set
</td>
</tr>

<tr class="govuk-table__row">
<td class="govuk-table__cell">opengraphImageUrl</td>
<td class="govuk-table__cell">Variable</td>
<td class="govuk-table__cell">Set the URL for the Open Graph image meta tag. The URL must be absolute, including the protocol and domain name.</td>
</tr>

<tr class="govuk-table__row">
<td class="govuk-table__cell">pageTitle</td>
<td class="govuk-table__cell">Block</td>
Expand Down

0 comments on commit 57572f4

Please sign in to comment.