ドキュメント

クイックスタート

プロジェクト構成・Eleventyセットアップ・初期設定のガイドです。

← 目次に戻る


1. インストール

npm install @ak2lab/engine

新規プロジェクトは create-ak2-site スキャフォールドの使用を推奨します(ディレクトリ構成・設定ファイルを自動生成)。


2. ディレクトリ構成

新しいサイトプロジェクトの推奨ディレクトリ構成です。

my-site/
├── _data/
│   ├── site.json     # サイトメタデータ(必須)
│   └── nav.json      # ナビゲーション(必須)
├── _includes/
│   └── layouts/
│       └── base.njk  # ベースレイアウト(サイト固有)
├── index.md          # トップページ
├── site.css          # サイト固有CSS
├── .eleventy.js
└── package.json

3. 起動コマンド

コマンド 説明
npm run start:sandbox Sandboxの開発サーバー起動(http://localhost:8080/
npm run build:sandbox Sandboxのプロダクションビルド(sandbox/_site/ に出力)

コードを保存すると 自動でブラウザがリロード されます(chokidar + WebSocket + morphdom)。


4. Sandbox テストページ一覧

URL 内容
/ Sandbox インデックス
/effects/ 背景エフェクト動作確認
/blocks/ ブロックプラグイン動作確認
/layout/ レイアウトプラグイン動作確認
/buttons/ ボタンプラグイン動作確認(GSAP必須)
/menubar/ layout-header-nav 全バリアント確認
/concept/ article.njk レイアウトのデモ
/interaction/ カーソル・カード・ウェーブボタン確認
/docs/ このドキュメント

5. 最初のページを作る

最もシンプルなページ(Markdownのみ)

---
layout: layouts/base.njk
title: "ホーム"
---
# ようこそ
ここに本文を書きます。

YAMLセクションを使ったランディングページ

詳しくは YAMLセクション アーキテクチャ を参照してください。

---
layout: layouts/base.njk
title: "ホーム"
navBg: "solid"
sections:
  - type: hero
    subtitle: "WELCOME"
    title: "サイト名"
    lead: "サイトの説明文。"
    effects:
      - BgSnowEffect
  - type: feature-grid
    heading: "MENU"
    subheading: "メニュー"
    items:
      - num: "01"
        title: "サービス"
        desc: "サービスの説明"
        href: "/service/"
---

↑ 目次 | 次のページ: データスキーマ →