# SiteKit ドキュメント（全文） > SiteKit は、静的サイト（HTML）に script を1行と HTML の属性を足すだけで、「お店の人が管理画面から直せる箇所（CMS）」と「お問い合わせフォーム（保存・自動返信・メール／Slack 通知）」を後付けする部品です。サイト側に JavaScript は書きません。 - 読み込むスクリプト: `https://cdn.sitekit.example/sitekit.js`（`data-site` にサイト ID） - フォームは `
`、入力の name は forms[].fields の key と一致させる。ボット対策の `_hp` 入力（隠す）は必須 - 直せる箇所は `data-cms="."` などの属性で印を付ける。何を直せるかは schema.json で宣言する - CMS が止まっても、HTML に書いた静的な文言がそのまま表示される（サイトは止まらない） - CLI・MCP サーバー・API キー・セルフ登録は準備中（近日）。それまでは HTML の属性と管理画面で使う --- # はじめに > できることと、5分で動かす手順（script を1行 → 属性を付ける → 管理画面で確かめる）。 URL: https://sitekit.example/docs ## SiteKit でできること SiteKit は、できあがった静的サイト（HTML）に後から付ける部品です。サイトをどう作ったかは問いません。AI に作らせた HTML でも、手で書いた HTML でも同じように使えます。 付けられるものは3つです。 - **お店の人が直せる箇所（CMS）** — 営業時間・お知らせ・写真など、HTML に印を付けた箇所を、お店の人が管理画面から直せます - **お問い合わせフォーム** — 送信の受付・保存、お店へのメールと Slack の通知、お客様へのお礼メール（自動返信） - **流入元（UTM）の記録と GTM の読み込み** — 広告から来た人の `utm_*` などを覚えておき、フォームの送信に添えます サイト側で JavaScript は書きません。hidden 項目を足す必要もありません。script を1行入れて、HTML に属性を付けるだけです。 **CMS が止まってもサイトは止まりません。** 値が届かないときは、HTML に書いた静的な文言がそのまま表示されます。だから HTML の文言は、それだけ読んで意味が通る内容にしておきます。 ## 5分で動かす ### 1. サイトを登録して、サイト ID を受け取る （近日） 登録すると、無料の Dev プランでサイトが1つ作られ、サイト ID（例: `hanaya`）が決まります。セルフサービスの登録画面は準備中です。開発用・プレビュー用のドメイン（`localhost` や `*.pages.dev` など）で動かせます。詳しくは [プランと上限](https://sitekit.example/docs/plans)。 ### 2. script を1行入れる `` の直前か、`` に `defer` 付きで入れます。`data-site` にサイト ID を書きます。 ```html ``` ### 3. 属性を付ける フォームは、`` に `data-sitekit-form` を付けるだけです。送信処理は script が行います。 ```html ``` お店の人に直してもらう箇所には `data-cms` を付けます。中の文言は、値が届かないときにそのまま出る既定の文言です。 ```html
営業日
月〜土
時間
10:00 - 18:00
``` ### 4. schema.json で「何を直せるか」「どんなフォームか」を決める 上の HTML に合わせると、こう書きます。`forms[].key` がフォームの `data-sitekit-form` の値と、`fields[].key` が入力の `name` と一致している必要があります。 ```json { "locales": ["ja"], "groups": [ { "key": "hours", "label": "営業時間", "fields": [ { "key": "days", "label": "営業日", "type": "text" }, { "key": "time", "label": "時間", "type": "text" } ] } ], "forms": [ { "key": "contact", "label": "お問い合わせ", "fields": [ { "key": "name", "label": "お名前", "type": "text", "required": true }, { "key": "email", "label": "メールアドレス", "type": "email", "required": true }, { "key": "message", "label": "お問い合わせ内容", "type": "textarea" } ] } ] } ``` 書き方の全体は [schema.json の書き方](https://sitekit.example/docs/schema)。schema.json をサイトに反映する手段（管理画面でのサイト追加、CLI の `schema push`、MCP）はセルフサービス版とあわせて提供します （近日）。 ### 5. 管理画面で確かめる [管理画面](https://app.sitekit.example) にログインすると、schema.json に書いた項目が入力欄として並びます。値を直して公開すると、最長1分でサイトに反映されます（サイトの再デプロイは要りません）。フォームから送ったお問い合わせも、管理画面の一覧に届きます。 > 値をサーバー側で HTML に埋め込むには、Cloudflare Pages の中継（Pages Functions）を使います。ほかのホスティングでは script の `data-embed` で表示時に埋め込みます。違いは [中継とホスティング](https://sitekit.example/docs/hosting) にあります。 ## 用語 | 用語 | 意味 | |---|---| | サイト ID | サイトごとの識別子。script の `data-site`、API の URL に入る | | schema.json | お店の人が直せる項目と、フォームの項目を宣言するファイル | | 公開 JSON | 公開中の内容をまとめた JSON。中継や `data-embed` がこれを読んで HTML に埋める | | 中継 | Cloudflare Pages の Pages Functions。配信前に公開 JSON の値を HTML に埋め込む | | 主言語 | schema.json の `locales` の先頭。お店の人が入力する言語で、翻訳が無いときの表示にも使う | ## 次に読む - [script タグ](https://sitekit.example/docs/script) — 属性の一覧と、script だけで動くもの - [直せる箇所の印（CMS）](https://sitekit.example/docs/cms) — テキスト・写真・お知らせの一覧・多言語 - [フォーム](https://sitekit.example/docs/forms) — 表示・通知・自動返信・テスト送信 - [AI エージェントに渡す](https://sitekit.example/docs/agents) — Claude Code や Cursor にそのまま貼れる指示文 --- # script タグ > 1行の script で動くもの（流入元の記録・フォーム送信・GTM）と、属性の一覧。 URL: https://sitekit.example/docs/script ## 書き方 `` の直前、または `` に `defer` 付きで1行入れます。 ```html ``` これだけで次の3つが動きます。 - **流入元（UTM）の記録** — 広告などから来た人の `utm_*` / `gclid` / `fbclid` をブラウザに覚えておき、フォーム送信のときに自動で添える - **フォーム送信** — `data-sitekit-form` を付けた `
` を、ページを移動せずに送る - **GTM の読み込み** — `data-gtm` を書いたときだけ ## 属性の一覧 | 属性 | 必須 | 説明 | |---|---|---| | `data-site` | 必須 | サイト ID。無いときは**何もせず黙って終わる**（エラーも出さない） | | `data-locale` | | 取得する言語。省略すると ``、それも無ければ `ja` | | `data-gtm` | | GTM のコンテナ ID（`GTM-XXXXXXX` の形）。形が違えば無視する | | `data-embed` | | 表示時に CMS の値を埋め込む。中継を使えないホスティング向けで、**ふだんは付けない**（[中継とホスティング](https://sitekit.example/docs/hosting)） | - **接続先は属性で指定しません。** script 自身の `src` のオリジン（`https://cdn.sitekit.example`）に接続します。`src` が `http(s)` でない場合（ファイルを直接開いたときなど）は何もしません - **`integrity`（SRI）は付けません。** サイトの HTML を触らずに script を更新できるようにしているためです - 1ページに script を2つ置く使い方には対応していません ## 流入元（UTM）の記録 広告のリンクなどから来たときの次の値を、ブラウザの `localStorage` に記録します。 | 記録する値 | 内容 | |---|---| | `utm_source` / `utm_medium` / `utm_campaign` / `utm_term` / `utm_content` | URL の UTM パラメータ | | `gclid` / `fbclid` | Google 広告 / Meta 広告のクリック ID | | `landing` / `referrer` / `at` | 着地したページ・参照元・日時 | - 「最初に来たとき（first）」と「最後に来たとき（last）」の2つを覚えます。保存期間は 90 日です - フォームを送ると、お問い合わせと一緒に保存されます。サイト側で hidden 項目を足す必要はありません - 1つの値が 500 文字を超える場合は切り詰めて記録します - ブラウザが `localStorage` を使わせない設定のときは記録しません（フォームの送信は動きます） ## GTM の読み込み `data-gtm` に書いたコンテナを読み込みます。 ```html ``` 管理画面の「設定」でも GTM ID を入れられます。こちらは中継（Cloudflare Pages）が `` にタグを差し込む経路で、反映は公開 JSON のキャッシュ（60秒）が切れたあとです。**両方に書くと、差し込まれたタグと `data-gtm` のコンテナが食い違います。** 中継を使うサイトでは `data-gtm` は書かず、管理画面で設定してください。 フォーム送信を GTM で拾う方法は [フォーム](https://sitekit.example/docs/forms#送信を-gtm-で拾う) にあります。 ## window.SiteKit 読み込み後に `window.SiteKit` ができます。ふだんは触らなくてかまいません。 | メンバー | 説明 | |---|---| | `SiteKit.version` | ビルドのバージョン文字列 | | `SiteKit.attribution()` | 記録中の流入元。無ければ `null` | | `SiteKit.bindForms()` | フォームを結び付け直す。あとから JavaScript でフォームを足したときに呼ぶ | | `SiteKit.refresh()` | `localStorage` から流入元を読み直す | ## キャッシュ script（`https://cdn.sitekit.example/sitekit.js`）は5分キャッシュされます。不具合の修正は、サイトの HTML を触らずにおおむね5分で全訪問者へ行き渡ります。逆に、バージョンを固定する使い方には向きません。 ## CSP を設定している場合 script タグ（と `data-gtm`）だけの場合、許可するオリジンは次の2つです。 ```text script-src 'self' https://cdn.sitekit.example https://www.googletagmanager.com; connect-src 'self' https://cdn.sitekit.example; ``` 中継で GTM を差し込む場合は、インラインの GTM スニペットが `` に入るため、`'unsafe-inline'` か nonce が要ります。`'unsafe-inline'` を許せないサイトでは `data-gtm` を使うほうが素直です。GTM が読み込むタグの分は、GTM の要件に従って別に追加してください。 --- # 直せる箇所の印（CMS） > data-cms 系の属性で、テキスト・写真・お知らせの一覧・記事ページ・多言語を、お店の人が直せるようにする。 URL: https://sitekit.example/docs/cms ## 考え方 HTML の要素に `data-cms` 系の属性を付けると、その箇所が管理画面から直せるようになります。何を直せるかは [schema.json](https://sitekit.example/docs/schema) で宣言します。 - 要素の中に書いた文言は**既定の文言**です。値が無いとき（未入力、または CMS に届かないとき）は、HTML がそのまま残ります - 値は文字としてエスケープされて入ります。お店の人の入力で HTML やスクリプトが差し込まれることはありません - 値の埋め込みは、Cloudflare Pages の中継（配信前）か `data-embed`（表示時）が行います（[中継とホスティング](https://sitekit.example/docs/hosting)） ## 印の一覧 | 属性 | 働き | |---|---| | `data-cms="key"` | 要素の中の文字を置き換える | | `data-cms-html="key"` | 同じく置き換え、改行を `
` にする | | `data-cms-src="key"` | `img` / `video` / `source` の `src` を置き換える | | `data-cms-attr="属性:key"` | 任意の属性を置き換える（例: `content:title`、`href:url`） | | `data-cms-blocks="key"` | 記事本文（ブロックの並び）を中に描く | | `data-cms-hide-empty` | 値が空文字のとき要素ごと消す（`data-cms` / `data-cms-html` だけに効く） | | `