diff options
author | Francesco <tomaselli.fr@gmail.com> | 2025-05-16 18:39:22 +0200 |
---|---|---|
committer | Francesco <tomaselli.fr@gmail.com> | 2025-05-16 18:39:22 +0200 |
commit | 02934adef1e55ad9ce16f9eba62d96f69a39e401 (patch) | |
tree | 4bad0adb35f9571b4a72df3d09208d66ae1b01f1 | |
parent | f5e02840e3094bb5251bd00de57612931f2ce032 (diff) |
Update other params doc
-rw-r--r-- | wiki/features/other-parameters.md | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/wiki/features/other-parameters.md b/wiki/features/other-parameters.md index cf6b7f6..04db89a 100644 --- a/wiki/features/other-parameters.md +++ b/wiki/features/other-parameters.md @@ -99,14 +99,16 @@ You can easily generate favicons using [this website](https://realfavicongenerat ## OpenGraph -### Custom `og:image` (link preview images) +**Custom `og:image` (link preview images)** -Typo allows you to customize the image shown in the card generated by most social media apps (X/Bluesky/WhatsApp) when you share a link to your site. These apps follow the [OpenGraph protocol](https://ogp.me) and look for `og:image` meta tags in the markup of the links you share. Typo will render the `og:image` meta tag provided a suitable one can be found. +Typo allows you to customize the image shown in the card generated by most social media apps (X/Bluesky/WhatsApp) when you share a link to your site. + +These apps follow the [OpenGraph protocol](https://ogp.me) and look for `og:image` meta tags in the markup of the links you share. Typo will render the `og:image` meta tag provided a suitable one can be found. -> [!note] > A size of 1200x630 is generally recommended for preview images. -A simple way to tell Hugo about the preferred image(s) to be used for `og:image` is by using the frontmatter `images` array with explicit paths to images. Otherwise, you can refer to [Hugo docs](https://gohugo.io/templates/embedded/#configuration-open-graph) on how the default template function looks for a suitable image. Typo respects and uses the image found in these aforementioned ways but otherwise, looks into the following cases. +A simple way to tell Hugo about the preferred image(s) to be used for `og:image` is by using the frontmatter `images` array with explicit paths to images. +Otherwise, you can refer to [Hugo docs](https://gohugo.io/templates/embedded/#configuration-open-graph) on how the default template function looks for a suitable image. Typo respects and uses the image found in these aforementioned ways but otherwise, looks into the following cases. To show the same preview image across all your pages not fitting the above conditions, copy the preview image to the location `/assets/images/og-image.png`. `.webp` and `.jpg` files are also supported. This image will usually be applied for links to the home page and other links without any explicitly specified images. @@ -128,7 +130,7 @@ Overriding `og-image.html` will still respect frontmatter/Hugo processing config ## Mermaid Diagrams -Mermaid diagrams are supported, just follow [this reference](https://gohugo.io/content-management/diagrams/#mermaid-diagrams) to use them. You can set Mermaid's light- and dark themes in your config; they switch with your blog's light/dark state. These are the defaults: +Mermaid diagrams are supported, you can set light and dark themes in your config and they switch with your blog's light/dark state. Below are the default values: ```toml [params] |