getSiteSettings() で読むサイト名・説明・ロゴ

全ページで使うサイト名とキャッチフレーズ、ロゴの取得方法と、設定が空のときの表示を確認します。

目次

サイト名やキャッチフレーズを表示するには、getSiteSettings() を使います。共通ヘッダーでこの値を読めば、管理者がサイト名を保存し直したとき、各ページのコードを直す手間が省けます。

引数と戻り値

引数はありません。await getSiteSettings() を実行すると、設定済みの項目を持つオブジェクトが返ります。使いたい項目が設定されているかは、表示するときに確かめます。

読む場所用途練習サイトで読めた値
settings.titleサイト全体の名前週末ノート
settings.taglineサイトの短い紹介文休日の小さな発見
settings.logo?.url登録したロゴ画像のURL未設定のため表示できるURLはありませんでした

ロゴを登録する前もサイト名を表示する

初めて試す方は「週末ノート」を準備してください。教材にはサイト名とキャッチフレーズが入っています。

練習サイトの src/pages/site-sample.astro に書いて /site-sample/ を開くと、サイト名がトップへのリンクになり、下にキャッチフレーズが出ます。同じ表示を全ページで使うときは、共通レイアウトのヘッダーに移します。

---
import { getSiteSettings } from 'emdash';

const settings = await getSiteSettings();
const siteName = settings.title?.trim() || 'ホーム';
---
<header>
  <a href="/">
    {settings.logo?.url
      ? <img src={settings.logo.url} alt={siteName} />
      : siteName}
  </a>
  {settings.tagline && <p>{settings.tagline}</p>}
</header>

サイト名が空でもリンクに「ホーム」と表示されます。ロゴを登録すると画像がリンクになり、読み上げ用の代替テキストにはサイト名を使います。

見出しに「週末ノート」ではなく「週末の記録 01」を出したいときは、記事ごとの post.data.title を読みます。公開先やデータベース接続の設定を調べるときは設定ファイルのリファレンスを参照してください。

公式の参照元

関連ガイド

メニュー
ホーム公式ドキュメント (別タブで開く)

キーワードを入力すると、ガイドの内容から探せます。