選んだ関連記事を表示し、下書きは除く

参照用の入力欄で選んだ記事を詳細ページに表示し、非公開の記事が混ざらないか確かめます。

目次

記事の下に、編集者が選んだ関連記事を並べられます。記事のタイトルやURLを毎回手書きせず、EmDashの「参照」という仕組みでつなぎます。参照は「この記事から、別の記事を指す情報」です。

先に用意するもの

写真付き一覧のガイドの「練習用サイトを準備する」まで済ませてください。同じダウンロード教材「週末ノート」を使います。EmDash 1.4.0、Astro 7.4.5、Node.js 24.22.1が対象です。実行確認はmacOSで行いました。Windows向けの入力例はコマンドプロンプト用で、Windows実機では未確認です。

以下のファイル名は、特に断りがなければ教材の weekend-note フォルダーからの場所です。ファイルの内容はVS Codeで編集し、指定された名前で保存します。コマンドはファイルに保存せず、コマンド入力画面へ貼り付けて実行します。どちらも、囲みの前にある説明で作業する場所を確認してください。開発サーバーは weekend-note のコマンド入力画面で npm run dev を実行しておきます。

起動に使った画面は開いたままにします。このあとのコマンドは、別の入力画面で実行します。VS Code左側のファイル一覧で weekend-note フォルダーを右クリックし、**Open in Integrated Terminal(統合ターミナルで開く)**を選ぶと、そのフォルダーを作業場所にした画面を開けます。Windowsでは、パソコンの準備で選んだコマンドプロンプトを使います。

1. 関連記事の入力欄を確認する

教材の seed/seed.json には、次の欄を用意しています。最初の準備で登録済みなので、この実習のためにもう一度seedを実行する必要はありません。

{
  "slug": "related_posts",
  "label": "関連記事",
  "type": "reference",
  "validation": {
    "targetCollection": "posts",
    "multiple": true
  }
}

reference が他の記事を選ぶ型、targetCollection: 'posts' が選択元、multiple: true が複数選択の指定です。

管理画面で「週末の記録 01」を開き、「関連記事」の「参照を追加」を押します。「週末の記録 02」と「公開しない練習用の下書き」を選び、「選択した項目を追加」を押します。保存後、「変更を公開」と確認画面の「変更を公開」を押してください。

2. 詳細ページで参照先を読む

src/pages/posts/[slug].astro が詳細ページです。角括弧もファイル名の一部です。全体を確認します。

---
import { decodeSlug, getEmDashEntry } from 'emdash';
import { PortableText } from 'emdash/ui';
import Layout from '../../layouts/Layout.astro';
const slug = decodeSlug(Astro.params.slug);
if (!slug) return new Response('記事が見つかりません。', { status: 404 });
const { entry: post, error, cacheHint } = await getEmDashEntry('posts', slug, { references: { related_posts: { limit: 6 } } });
if (error) return new Response('記事を読み込めませんでした。', { status: 500 });
if (!post) return new Response('記事が見つかりません。', { status: 404 });
if (Astro.cache?.enabled) Astro.cache.set({ ...cacheHint, maxAge: 300 });
const related = post.references?.related_posts.entries ?? [];
---
<Layout title={post.data.title}><h1>{post.data.title}</h1><PortableText value={post.data.content ?? []}/>
{related.length > 0 && <aside><h2>関連記事</h2><ul>{related.map(entry => <li><a href={`/posts/${entry.id}/`}>{entry.data.title}</a></li>)}</ul></aside>}
<a href="/cards/">記事一覧へ戻る</a></Layout>

references の指定で related_posts の中身を最大6件まで読みます。結果は post.references に入ります。タイトルだけでなく、リンク先も参照先の記事から作ります。

related.length > 0 は、表示できる関連記事があるときだけ見出しを出す条件です。cacheHint の行はキャッシュの実習でも使います。開発中はキャッシュが無効なので、ここではそのまま進めて構いません。

コードに出てくる references や entries は、参照フィールドの定義と戻り値で一つずつ確認できます。

3. 公開ページで下書きが出ないか確認する

http://127.0.0.1:4350/posts/note-01/ を開きます。「関連記事」に「週末の記録 02」があり、「公開しない練習用の下書き」がなければ成功です。関連記事として選んだ下書きも、読者向けの一覧には表示しません。

検証では、選択した2件のうち公開済みの1件だけが表示されました。管理用APIで自前の一覧を作ると同じ条件になるとは限らないので、この例では公開向けの取得関数を使います。

何も出ない場合は、参照を追加した後の変更を公開したかを見ます。記事が見つからないURLでは404、取得そのものに失敗したときは500に分けています。

終了するとき・次回続けるとき

npm run devを実行した画面が入力待ちに戻っていなければ、その画面でControl + Cを押して停止します。入力待ちに戻ったあともサイトが動き続けている場合は、weekend-noteでnpx astro dev stopを実行します。次回は同じフォルダーでnpm run devを実行してください。初期データを入れるseedコマンドを繰り返す必要はありません。

公式の参照元

関連ガイド

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

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