---
title: クイックスタート
sidebar:
  order: 10
---

svelte-zukan は素の Vite + Svelte でも SvelteKit 3 以上でも動きます。Vite 8 以上、Svelte 5.57.1 以上、Node 22.17 以上が必要です。Vite 専用のフック（`configureServer`、`hotUpdate`、`buildApp`）を使うため、Vite 以外のバンドラーでは動きません。

AI のコーディングエージェントを使っているなら、`npx skills add oekazuma/svelte-zukan` で[エージェントスキル](/svelte-zukan/ja/skills)を入れて、svelte-zukan の導入を頼めます。エージェントはこのページの手順に沿って、プロジェクトに合ったオプションを選び、カタログファイルと説明を書きます。

## インストール

```sh npm
npm install -D svelte-zukan
```

```sh pnpm
pnpm add -D svelte-zukan
```

```sh Yarn
yarn add -D svelte-zukan
```

## プラグインを追加する

`zukan()` は `sveltekit()` や `svelte()` より前に置きます。

```ts SvelteKit
// vite.config.ts
import { sveltekit } from '@sveltejs/kit/vite';
import { defineConfig } from 'vite';
import { zukan } from 'svelte-zukan/vite';

export default defineConfig({ plugins: [zukan(), sveltekit()] });
```

```ts Vite + Svelte
// vite.config.ts
import { svelte } from '@sveltejs/vite-plugin-svelte';
import { defineConfig } from 'vite';
import { zukan } from 'svelte-zukan/vite';

export default defineConfig({ plugins: [zukan(), svelte()] });
```

## カタログファイルを書く

コンポーネントの隣に `<Name>.zukan.svelte` を置き、例ごとに `<Section>` で囲みます。

```svelte
<!-- src/lib/Button/Button.zukan.svelte -->
<script lang="ts">
  import { Section } from 'svelte-zukan';
  import Button from './Button.svelte';
</script>

<Section title="Basic">
  <Button>Click me</Button>
</Section>

<Section title="Disabled">
  <Button disabled>Disabled</Button>
</Section>
```

## カタログを開く

dev サーバーを起動して `/__zukan/` を開きます。起動時にターミナルへ出る URL 一覧にも、カタログの URL が載ります。

Vite の `base` や SvelteKit の `paths.base` を設定しているときは、カタログはその下に移ります。`base: '/app/'` でも `paths.base: '/app'` でも `/app/__zukan/` です。

トップページには、すべてのコンポーネントが小さなプレビュー付きで並びます。詳細ページには、各セクションのプレビューと、幅・背景・計測・アクセシビリティ検査のツールバー、各セクションのコード、コンポーネントの props が並びます。どれも[カタログの使い方](/svelte-zukan/ja/catalog-ui)でキーボードショートカットとあわせて説明しています。

## 次のステップ

**[カタログの使い方](/svelte-zukan/ja/catalog-ui)**

プレビューのツールバー、アクセシビリティパネル、検索、キーボードショートカット。

**[カタログファイル](/svelte-zukan/ja/catalog-files)**

`<Section>` のルール、Markdown の説明、コード表示に出るもの。

**[設定](/svelte-zukan/ja/options)**

`zukan()` のすべてのオプション。

**[エージェントスキル](/svelte-zukan/ja/skills)**

Claude Code、Cursor、Codex に、導入、カタログファイルの作成、Storybook からの移行を任せる。
