Astro Sarkara

Section 9

OGP画像を設定する

向学立志

Astro SarkaraはThe Open Graph Protocol (OGP)の設定にデフォルトで対応しています。サイトメタデータsiteMetadata.imagepublic/ディレクトリに置いた画像ファイルのパス(publicフォルダを起点としたファイルパス)を設定することで、OGP画像を適用することができます。

export const siteMetadata = defineSiteMetadata({
  title: "Site title",
  description: "Site description",
  /**
   * publicフォルダを起点としたファイルパスを設定
   * /public/ogimage.jpeg の場合、以下のように設定
   */
  image: "/ogimage.jpeg",
});

ページごとのOGP画像の設定

またAstro Sarkaraレイアウトのimage属性に画像を設定することで、サイトメタデータの設定を上書きしてOGP画像ことができます。

public/ディレクトリの画像

publicディレクトリに画像を置く場合は、サイトメタデータと同様にpublicフォルダを起点としたファイルパスを設定することで、サイトメタデータの設定を上書きすることができます。

---
import { SarkaraLayout } from "@cieloazul310/astro-sarkara";

---
<SarkaraLayout image="/ogp_second.png">
  {/* contents */}
</SarkaraLayout>

src/傘下の画像

src/ディレクトリ傘下の画像を設定する場合は、Astroコンポーネントのフロントマターで画像をインポートして<SarkaraLayout>image属性に設定してください。src/ディレクトリに置かれた画像はAstroの機能によって変換、最適化などの処理がされます。

---
import { SarkaraLayout } from "@cieloazul310/astro-sarkara";
import ogp from "../assets/ogp.png";

---
<SarkaraLayout image={ogp}>
  {/* contents */}
</SarkaraLayout>

Astroのコンテンツコレクションを使用する場合は、MarkdownのフロントマターにfeaturedImgといったスキーマを設定することでレイアウトにOGP画像を渡すことができます。詳しくは以下のページを参照ください。

画像
docs.astro.build

Section 9

OGP画像を設定する

Tutorial Top Top

Astro Sarkara