データスキーマ | @ak2lab/engine Sandbox

site.json

サイト全体のメタデータを定義します。

{
  "name": "サイト名",
  "sub": "サブテキスト（ヘッダーブランド名の下）",
  "fullName": "フルサイト名（SEO等に使用）",
  "description": "サイト説明文（meta description）",
  "url": "https://example.com",
  "logoHref": "/",
  "logoSvg": "<svg ...>...</svg>",
  "footerLogoSvg": "<svg ...>...</svg>",
  "footerDesc": "フッター説明文（HTML可）",
  "copyright": "Example Inc. All Rights Reserved.",
  "footerAboutLinks": [
    { "label": "About", "url": "/about/" },
    { "label": "Contact", "url": "/#contact" }
  ]
}

フィールド	必須	説明
`name`	✅	ヘッダーのブランド名
`sub`	✅	ブランド名の下のサブテキスト
`logoSvg`	✅	ヘッダー/フッターのロゴSVG（HTML文字列）
`logoHref`	—	ロゴのリンク先（デフォルト: `"/"`)
`footerLogoSvg`	—	フッター専用ロゴ（未指定時は `logoSvg` を使用）
`footerDesc`	—	フッターの説明文（HTML可）
`copyright`	—	コピーライトテキスト（年号は自動）
`footerAboutLinks`	—	フッターABOUTカラムのリンク配列

nav.json

グローバルナビゲーションのリンクを定義します。

[
  { "label": "ホーム",      "url": "/",         "root": "/" },
  { "label": "サービス",    "url": "/service/",  "root": "/service" },
  { "label": "お問い合わせ", "url": "/#contact",  "root": "/#contact" }
]

フィールド	説明
`label`	表示テキスト
`url`	リンク先URL
`root`	アクティブ判定パスプレフィックス（`"/"` はトップページのみ）

effectClasses.json

エフェクトキー（フロントマターの effects: [key]）から JSクラス名へのマッピングです。@ak2lab/engine/sandbox/_data/effectClasses.json をそのままコピーして使用してください。

{
  "aurora":            "BgAuroraEffect",
  "snow":              "BgSnowEffect",
  "sakura":            "BgSakuraEffect",
  "firefly":           "BgFireflyEffect",
  "grid-construction": "BgGridConstruction",
  "lines":             "BgGridEffect",
  "sparks":            "BgSparksEffect",
  "rain":              "BgRainEffect",
  "ripple":            "BgRippleEffect",
  "shimmer":           "BgShimmerEffect",
  "stars":             "BgStarFieldEffect",
  "star-speed":        "BgStarSpeedEffect",
  "wave-ripple":       "BgWaveRippleEffect",
  "waves":             "BgWaveEffect"
}

注意: ページ全体エフェクト（effects: [key]）ではこのマッピングを使います。セクション個別エフェクト（sections[].effects[]）では JSクラス名を直接記述します（例: BgSnowEffect）。詳しくはエフェクトプラグインを参照してください。

前のページ: ← クイックスタート | ↑ 目次 | 次のページ: ベースレイアウト →