---
title: 設定
sidebar:
  order: 1
---

```ts
zukan({
  suffix: 'zukan',
  groups: { ui: 'src/lib', examples: ['src/examples', 'src/demo'] },
  wrapper: '.zukan/Wrapper.svelte',
  logo: '.zukan/logo.svg',
  title: 'zukan',
  locale: 'en',
  theme: 'dark',
  build: { outDir: 'zukan-dist' }
});
```

| オプション | 型                                   | 既定値     | 説明                                                                                                                                                 |
| ---------- | ------------------------------------ | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `suffix`   | `string`                             | `'zukan'`  | カタログファイルの接尾辞。`/^[a-z0-9-]+$/i` に合う必要がある                                                                                         |
| `groups`   | `Record<string, string \| string[]>` | 自動探索   | グループ名 → 探すディレクトリ。指定すると[自動探索](/svelte-zukan/ja/monorepo)は行わない。並び順はキーを書いた順。存在しないディレクトリはエラー                  |
| `wrapper`  | `string`                             | なし       | [プレビューを囲む](/svelte-zukan/ja/wrapper) `.svelte` のパス                                                                                                     |
| `logo`     | `string \| false`                    | 同梱のロゴ | サイドバーのロゴ画像のパス。`false` でロゴを出さず `title` の文字列を表示                                                                            |
| `title`    | `string`                             | `'zukan'`  | サイドバーのロゴの `alt` とページの `<title>`                                                                                                        |
| `locale`   | `'en' \| 'ja'`                       | `'en'`     | UI の言語。`<html lang>` もこの言語になる                                                                                                            |
| `theme`    | `'light' \| 'dark'`                  | なし       | カタログとすべてのプレビューをこの[テーマ](/svelte-zukan/ja/catalog-ui)に固定し、テーマの切り替えをなくす。指定しなければ、見る人がライトとダークを切り替えられる |
| `build`    | `boolean \| { outDir?: string }`     | `false`    | `vite build` のときにカタログを[静的に書き出す](/svelte-zukan/ja/static-export)。`true` なら `outDir` は `'zukan-dist'`                                           |

- パスはすべて Vite の root からの相対で、`.zukan/` のように `src` の外も指定できます
- 不正な値（`suffix` が規則に合わない、`locale` や `theme` が未知、指定したファイルやディレクトリがない、`groups` のキーやディレクトリの一覧が空）は、設定の読み込み時にエラーになります
- `groups` のディレクトリは、どのプラットフォームでも大文字と小文字を区別して照合します。macOS や Windows でも、`src/lib` というディレクトリを `src/Lib` と書くと、両方の綴りを示すエラーになります（Linux では見つからないエラーになります）。Vite のルートと別のドライブにあるディレクトリ（Windows）は照合しません
- `groups` のキーを数字だけにすると、JavaScript のオブジェクトの仕様で、宣言順ではなく数値順で並びます。グループ名には数字以外の文字を含めてください
- スキャンするディレクトリの中にある、ディレクトリへのシンボリックリンクはたどりません。リンク先も含めるには、`groups` でそのリンク自体を指定してください

## UI の言語

カタログの UI は既定で英語です。`locale: 'ja'` で日本語になります。アクセシビリティ検査の指摘もこの設定に従います。`groups` のキーやセクションのタイトルのように、利用側が書いた文字列は翻訳しません。プラグインのエラーメッセージは常に英語です。
