コンテンツにスキップ
Blume
日本語
Esc
移動開く⌘Jプレビュー
このページの内容

Open Graph 画像

すべてのページ向けに生成される 1200×630 のソーシャルカード — ブランディング、カードのレイヤー、非ラテン文字向けフォント、ページ単位のオーバーライドについて。

Blume は、すべてのページに対してビルド時に 1200×630 のソーシャルカードをレンダリングできます。Takumi のおかげでヘッドレスブラウザは不要で、ビルドは高速なままです。deployment.site が設定されているか自動検出された場合はデフォルトで有効になり(og:image の URL はクローラーにとって有用であるために絶対 URL である必要があります)、そうでない場合は無効です。どちらの挙動も enabled で上書きできます:

seo: {
  og: { enabled: true }, // or false to opt out even with a site set
}

生成されるカードをブランディングする

ローカルの SVG とカラーパレットを設定して、生成されるカードをブランドに合わせましょう。ロゴは public/ またはプロジェクトルートに配置できます。パレットの値を省略すると、その項目はデフォルトのままになります。

seo: {
  og: {
    logo: "/logo/og.svg",
    palette: {
      accent: "#ff5410",
      background: "#1d1d1d",
      foreground: "#fff6f2",
      muted: "#a6a19f",
      border: "#323232",
    },
  },
}

デフォルトでは、各カードはコンテンツとテーマから導出されます。見出しにはページタイトル、サブタイトルにはページの説明og:description と同じテキストなので、description よりも seo.description が優先されます)、アイブロウにはサイトタイトル、マークにはテーマのアクセントが使われます。画像は各ルートに対応する形で /og/<slug>.png から配信され、サーバーモードでも静的ファイルとしてプリレンダリングされます:

ページのルート 画像の URL
/ /og/index.png
/quickstart /og/quickstart.png
/guides/deploy /og/guides/deploy.png

任意のページで生成されたカードを上書きするには、seo.image を使います。public/ 内のファイルまたは外部 URL を指定できます。これは生成されたカードよりも優先され、og が無効な場合でも機能するため、カスタム画像と生成画像を組み合わせて使えます:

---
title: Pricing
seo:
  image: /og/pricing-custom.png
---

ページタイトルやサイトタイトルに含まれる絵文字は Twemoji のグリフとしてレンダリングされ、カードのレンダリング中に CDN から取得されます。そのため、タイトルに絵文字を含むビルドにはネットワークアクセスが必要です。各グリフは、いくつのページで使われていてもビルドごとに 1 回だけ取得されます。

カードのレイヤーを表示・非表示・上書きする

見出しに加えて、カードには 3 つのオプションレイヤーがあります。左上のブランドマーク(ロゴ、またはサイトタイトルの頭文字を配したアクセントタイル)、見出しの下のサブタイトル(ページの description、それがないページではサイトの description)、そしてリポジトリスラッグ(github から取得)とサイトの URL を含むフッターです。サイトの URL はデプロイ先サイトのホストに deployment.base を加えたもので、GitHub Pages のプロジェクトサイトであれば user.github.io/repo と表示されます。いずれも任意の文字列で上書きでき、false を指定すると非表示になります:

seo: {
  og: {
    site: "docs.acme.com", // footer URL text, or false to hide it
    description: false, // hide the subtitle on every card; a string replaces the site fallback
    logo: false, // no brand mark at all — not even the initial tile
  },
}

カードのフォント

デフォルトでは、カードは Takumi の組み込みフォントでレンダリングされます。このフォントはラテン文字のグリフしかカバーしていないため、他の文字体系(日本語、中国語、韓国語、アラビア語など)のタイトルは豆腐(空の四角)として表示されてしまいます。

theme.fonts を設定すれば、カードもそれに従います。 設定で独自のフォントを指定すると、生成されるカードは見出しをディスプレイフォントで、説明とフッターをボディフォントで自動的にレンダリングするため、共有リンクがサイトと一致します。非ラテン文字のカバーも含め、ここで設定すべきことは何もありません。(Google 以外のプロバイダーのファミリーはスキップされます — カードレンダラーは Google Fonts からしか取得できません — が、ローカルのフォントファイルは利用できます。)

サイトとは異なるフォントをカードで使いたい場合や、テーマに手を加えずに文字体系のカバー範囲を追加したい場合は、og.fonts を明示的に設定します。この設定は常にテーマ由来のフォントより優先されます:

seo: {
  og: {
    fonts: [
      "Noto Sans JP",
      { name: "Inter", weight: [400, 700] },
      { name: "Berkeley Mono", src: "./fonts/BerkeleyMono-Regular.woff2" },
    ],
  },
}

各エントリには、Google Fonts のファミリー名、weight(数値、リスト、または "100..900" のような可変範囲)と style"normal""italic"、またはその両方)を指定するオブジェクト、あるいはローカルのフォントファイルを指定できます。ローカルファイルの場合、src はプロジェクトルートから解決され、ファイル自身のメタデータに任せたくない場合は weightstyle を任意で指定できます。

Google のファミリーはビルド時に取得されるため、それらを使うビルドにはネットワークアクセスが必要です。また、レンダラーは各タイトルが実際に使用するグリフのサブセットのみを取得します。フォールバックはグリフ単位で行われるため、ファミリーを追加しても、他のフォントで描画できないグリフにしか影響しません。

og.fonts: [] と明示的に指定すると完全にオプトアウトでき、theme.fonts が設定されていてもカードは組み込みフォントのままになります。

カスタムページのタイトル

カスタム .astro ページ には読み取るフロントマターがないため、生成されるカードのタイトルはルートの最後の URL セグメントを人間向けに整形したものになります。/getting-started は「Getting Started」になりますが、/cli は「Cli」になってしまいます。こうしたカードには og.titles でルートをキーとして明示的に名前を付けられます("/" はホームを指し、指定しない場合そのカードにはサイトタイトルが表示されます):

seo: {
  og: {
    titles: {
      "/cli": "CLI",
    },
  },
}

エントリはカスタムページにのみ適用されます。コンテンツページのカードは常にページタイトルから見出しを取得するため、そちらはフロントマターでタイトルを付け直してください。

seo.image はフロントマターなので、Markdown と MDX のコンテンツにしか適用されません。カスタム .astro ページ に独自のソーシャル画像を設定するには — マーケティング用のホームページやランディングページ、そしてホームページだけに専用の共有画像を設定する方法として — PageLayoutogImage プロパティを渡してください。

このページは役に立ちましたか?