コンテンツにスキップ

リンクカード

記事本文に URL を単独の行で貼ると、ただのリンクではなく リンクプレビュー カード として表示されます。テーマはビルド時(Hugo の resources.GetRemote) にリンク先ページの Open Graph タグを読み取り、画像・タイトル・説明・サイト名を 表示します。

追加設定は不要です。リンクプレビューはデフォルトで常に有効です。

URL を単独の行に置きます:

https://gohugo.io/

または ogp ショートコード で明示的に挿入します:

{{< ogp "https://gohugo.io/" >}}

どちらも同じカードを描画します。

カードになるのは 単独の素の URL(表示テキストがリンク先と一致する自動リンク) だけです。それ以外はこれまで通りのまま変更されません。

  • [Hugo](https://gohugo.io/) のようなラベル付きリンクは通常のリンクのまま。
  • 相対リンク・内部リンク・アンカー・mailto: リンクも変更されません。

カードはリンク先の <head> から組み立てられます。

項目 取得元 フォールバック
タイトル og:title <title>
説明 og:description <meta name="description">
画像 og:image 無ければ省略
サイト名 og:site_name URL のホスト名

相対パスの og:image/cover.png//cdn/…)はリンク先を基準に解決され、 タイトルと説明の HTML エンティティはデコードされます。

リンク先に 利用可能な Open Graph 情報が無い 場合や、ビルド時に到達できない 場合は、URL は通常のリンクにフォールバックします。プレビューが取得できなくても ビルドが壊れることはありません。同一 URL はビルドごとに 1 回だけ取得されます (結果はキャッシュされます)。

リンクプレビューはデフォルトで有効です。サイト全体で無効化し、どこでも通常の リンクに戻したい場合は params.ogpCard.enabledfalse に設定します。

[params.ogpCard]
enabled = false
  • カード画像は遅延読み込み(loading="lazy")され、リンク先のホストから配信 されます(閲覧時にブラウザが取得します)。
  • プレビューは hugo build 中に取得されるため、ビルド環境からリンク先 URL への 外向き通信が必要です。制限された CI では、到達できないリンクは通常のリンクに フォールバックします。
  • これは、自分のページ が他所で共有されたときのプレビューを制御する OGP 画像 とは別の機能です。