Astro開発者のためのEmDash

このページ

EmDashはAstro専用に構築されたCMSです。データベースバックのコンテンツ、洗練された管理UI、WordPressスタイルの機能(メニュー、ウィジェット、タクソノミー)でAstroサイトを拡張しつつ、期待する開発者体験を維持します。

Astroについて知っていることはすべてそのまま適用されます。EmDashは既存のAstroワークフローの上にコンテンツ管理を追加します。

EmDashが追加するもの

EmDashはファイルベースのAstroサイトに欠けているコンテンツ管理機能を提供します:

機能説明
管理UI/_emdash/admin での完全なWYSIWYG編集インターフェース
データベースストレージSQLite、libSQL、Cloudflare D1、またはPostgreSQLにコンテンツを保存
メディアライブラリ画像やファイルのアップロード、整理、配信
ナビゲーションメニューネスト対応のドラッグ&ドロップメニュー管理
ウィジェットエリア動的なサイドバーとフッター領域
サイト設定グローバル設定(タイトル、ロゴ、ソーシャルリンク)
タクソノミーカテゴリー、タグ、カスタムタクソノミー
プレビューシステム下書きコンテンツ用の署名付きプレビューURL
リビジョンコンテンツのバージョン履歴

Astro Collections vs EmDash

Astroの astro:content コレクションはファイルベースでビルド時に解決されます。EmDashコレクションはデータベースバックでランタイムに解決されます。

AstroコレクションEmDashコレクション
ストレージsrc/content/ のMarkdown/MDXファイルSQLデータベース(SQLite、libSQL、D1またはPostgres)
編集コードエディタ管理UI
コンテンツ形式フロントマター付きMarkdownPortable Text(構造化JSON)
更新リビルドが必要即時(SSR)
スキーマcontent.config.ts のZod管理画面で定義、データベースに保存
最適な用途開発者が管理するコンテンツ編集者が管理するコンテンツ

両方を併用する

AstroコレクションとEmDashは共存できます。開発者コンテンツ(ドキュメント、変更履歴)にはAstroコレクションを、編集者コンテンツ(ブログ記事、ページ)にはEmDashを使用します:

---
import { getCollection } from "astro:content";
import { getEmDashCollection } from "emdash";

// ファイルからの開発者管理ドキュメント
const docs = await getCollection("docs");

// データベースからの編集者管理記事
const { entries: posts } = await getEmDashCollection("posts", {
  status: "published",
  limit: 5,
});
---

設定

EmDashには2つの設定ファイルが必要です。

Astroインテグレーション

以下の設定は、サーバー出力モードでEmDashをAstroインテグレーションとして登録します:

import { defineConfig } from "astro/config";
import react from "@astrojs/react";
import emdash, { local } from "emdash/astro";
import { sqlite } from "emdash/db";

export default defineConfig({
	output: "server", // EmDashに必須
	integrations: [
		react(), // 必須 — 管理UIはReactアプリ
		emdash({
			database: sqlite({ url: "file:./data.db" }),
			storage: local({
				directory: "./uploads",
				baseUrl: "/_emdash/api/media/file",
			}),
		}),
	],
});

Live Collections Loader

以下のファイルは、EmDashをライブコンテンツソースとして登録します:

import { defineLiveCollection } from "astro:content";
import { emdashLoader } from "emdash/runtime";

export const collections = {
	_emdash: defineLiveCollection({
		loader: emdashLoader(),
	}),
};

_emdash コレクションは内部的にコンテンツタイプ(記事、ページ、商品)にルーティングします。

コンテンツのクエリ

EmDashはAstroのライブコンテンツコレクションパターンに従うクエリ関数を提供し、{ entries, error } または { entry, error } を返します:

EmDash

import { getEmDashCollection, getEmDashEntry } from "emdash";

// 公開済みの全記事を取得 - { entries, error } を返す
const { entries: posts } = await getEmDashCollection("posts", {
status: "published",
});

// スラッグで単一の記事を取得 - { entry, error, isPreview } を返す
const { entry: post } = await getEmDashEntry("posts", "my-post");

Astro

import { getCollection, getEntry } from "astro:content";

// すべてのブログエントリーを取得
const posts = await getCollection("blog");

// スラッグで単一のエントリーを取得
const post = await getEntry("blog", "my-post");

フィルタリングオプション

getEmDashCollection はAstroの getCollection にはないフィルタリングをサポートしています:

const { entries: posts } = await getEmDashCollection("posts", {
	status: "published", // draft | published | archived
	limit: 10, // 最大結果数
	where: { category: "news" }, // タクソノミーフィルター
});

コンテンツのレンダリング

EmDashはリッチテキストをPortable Text(構造化JSONフォーマット)として保存します。PortableText コンポーネントでレンダリングします:

EmDash

---
import { getEmDashEntry } from "emdash";
import { PortableText } from "emdash/ui";

const { slug } = Astro.params;
const { entry: post } = await getEmDashEntry("posts", slug);

if (!post) {
return Astro.redirect("/404");
}

---

<article>
  <h1>{post.data.title}</h1>
  <PortableText value={post.data.content} />
</article>

Astro

---
import { getEntry, render } from "astro:content";

const { slug } = Astro.params;
const post = await getEntry("blog", slug);
const { Content } = await render(post);

---

<article>
  <h1>{post.data.title}</h1>
  <Content />
</article>

動的機能

EmDashはAstroのコンテンツレイヤーには存在しないWordPressスタイルの機能のAPIを提供します。

ナビゲーションメニュー

以下のレイアウトは位置でメニューを取得し、ネストされたアイテムでレンダリングします:

---
import { getMenu } from "emdash";

const primaryMenu = await getMenu("primary");
---

{primaryMenu && (
  <nav>
    <ul>
      {primaryMenu.items.map(item => (
        <li>
          <a href={item.url}>{item.label}</a>
          {item.children.length > 0 && (
            <ul>
              {item.children.map(child => (
                <li><a href={child.url}>{child.label}</a></li>
              ))}
            </ul>
          )}
        </li>
      ))}
    </ul>
  </nav>
)}

ウィジェットエリア

以下のレイアウトはウィジェットエリアを取得し、各ウィジェットをレンダリングします:

---
import { getWidgetArea } from "emdash";
import { PortableText } from "emdash/ui";

const sidebar = await getWidgetArea("sidebar");
---

{sidebar && sidebar.widgets.length > 0 && (
  <aside>
    {sidebar.widgets.map(widget => (
      <div class="widget">
        {widget.title && <h3>{widget.title}</h3>}
        {widget.type === "content" && widget.content && (
          <PortableText value={widget.content} />
        )}
      </div>
    ))}
  </aside>
)}

サイト設定

以下のコンポーネントはグローバルなサイト設定を読み取り、ロゴまたはタイトルをレンダリングします:

---
import { getSiteSettings, getSiteSetting } from "emdash";

const settings = await getSiteSettings();
// または個別の値を取得:
const title = await getSiteSetting("title");
---

<header>
  {settings.logo ? (
    <img src={settings.logo.url} alt={settings.title} />
  ) : (
    <span>{settings.title}</span>
  )}
  {settings.tagline && <p>{settings.tagline}</p>}
</header>

プラグイン

フック、ストレージ、設定、管理UIを追加するプラグインでEmDashを拡張します:

import react from "@astrojs/react";
import emdash from "emdash/astro";
import seoPlugin from "@emdash-cms/plugin-seo";

export default defineConfig({
	integrations: [
		react(),
		emdash({
			// ...
			plugins: [seoPlugin({ generateSitemap: true })],
		}),
	],
});

definePlugin でカスタムプラグインを作成します:

import { definePlugin } from "emdash";

export default definePlugin({
	id: "analytics",
	version: "1.0.0",
	capabilities: ["content:read"],

	hooks: {
		"content:afterSave": async (event, ctx) => {
			ctx.log.info("Content saved", { id: event.content.id });
		},
	},

	admin: {
		settingsSchema: {
			trackingId: { type: "string", label: "トラッキングID" },
		},
	},
});

サーバーレンダリング

EmDashサイトはSSRモードで動作するため、コンテンツはランタイムで配信され、変更は即座に反映されます。

getStaticPaths を使った静的ページでは、コンテンツはビルド時に取得されます:

---
import { getEmDashCollection, getEmDashEntry } from "emdash";

export async function getStaticPaths() {
  const { entries: posts } = await getEmDashCollection("posts", {
    status: "published",
  });

  return posts.map((post) => ({
    params: { slug: post.data.slug },
  }));
}

const { slug } = Astro.params;
const { entry: post } = await getEmDashEntry("posts", slug);
---

動的ページでは、prerender = false を設定してリクエストごとにコンテンツを取得します:

---
export const prerender = false;

import { getEmDashEntry } from "emdash";

const { slug } = Astro.params;
const { entry: post, error } = await getEmDashEntry("posts", slug);

if (error) {
  return new Response("Server error", { status: 500 });
}

if (!post) {
  return new Response(null, { status: 404 });
}
---

次のステップ