---
title: svelte-zukan
description: Svelte のコンポーネントカタログ。コンポーネントの隣にカタログファイルを置くと、一覧・プレビュー・コード表示がそろいます。
seo:
  title: svelte-zukan ・ Svelte のコンポーネントカタログ
  description: svelte-zukan は、コンポーネントの隣に置いたカタログファイルから Svelte のコンポーネントカタログを配信する Vite プラグインです。
---

zukan は日本語の「図鑑」のことです。

<img
  className="shot-light"
  src="/svelte-zukan/screenshots/detail-ja-light.webp"
  alt="カタログの詳細ページ。コンポーネントの説明、ツールバー付きのライブプレビュー、目次が並んでいます"
  width="1280"
  height="700"
/>
<img
  className="shot-dark"
  src="/svelte-zukan/screenshots/detail-ja-dark.webp"
  alt="カタログの詳細ページ。コンポーネントの説明、ツールバー付きのライブプレビュー、目次が並んでいます"
  width="1280"
  height="700"
/>

**vite.config.ts に 1 行足すだけ**

Vite のプラグインに `zukan()` を足します。`src` にルートも設定ファイルも置きません。

**コンポーネントの隣に置く**

`Button.zukan.svelte` と `Button.zukan.md` を `Button.svelte` の隣に置くと、カタログに載ります。

**プレビューとコード**

セクションごとに幅を変えられる iframe でプレビューし、コードは参照している変数の定義つきで表示します。

**Props とアクセシビリティ**

コンポーネントから読み取った Props の一覧と、axe-core
による検査。検査では問題のある要素を枠線で示し、見え方の再現もできます。

**スマートフォンからデスクトップまでの幅**

375px から 1280px までのプリセット。狭い幅は中央に、広い幅は画面に収まるよう縮小して表示します。

**静的な書き出し**

`build: true` にすると、`vite build` のときに静的なカタログも書き出します。どのサブパスに置いても動きます。

## AI エージェントにカタログを書かせる

[エージェントスキル](/svelte-zukan/ja/skills)を入れて、Claude Code、Cursor、Codex などのエージェントに「svelte-zukan を入れて、コンポーネントをカタログに載せて」と頼みます。エージェントは、プロジェクトに合ったオプションでプラグインを追加し、コンポーネントごとにカタログファイルを書き、props の JSDoc と `.zukan.md` ファイルで説明を付け、結果を確かめます。

```sh
npx skills add oekazuma/svelte-zukan
```

**[はじめる](/svelte-zukan/ja/quickstart)**

svelte-zukan をインストールして、最初のカタログファイルを書きます。

**[svelte-zukan を選ぶ理由](/svelte-zukan/ja/why)**

力を入れていること、Storybook との比較、Storybook を選ぶべき場面。

**[デモを見る](https://oekazuma.github.io/svelte-zukan/demo/ja/)**

svelte-zukan 自身のコンポーネントのカタログです。`build: true` で書き出しています。

**[GitHub で見る](https://github.com/oekazuma/svelte-zukan)**

ソースを読んだり、issue を立てたり、コントリビュートしたりできます。

svelte-zukan は Svelte の公式プロジェクトではありません。Svelte チームとの提携や承認もありません。ロゴの S の図形は Svelte のロゴに由来します。
