mkdocs.yml

# English site -- the default locale, so it builds to the site root and keeps the plain
# `mkdocs.yml` name that the tooling looks for when no `-f` is given.
#
# Everything not listed here comes from mkdocs.base.yml. Before adding anything, read the
# note there about sequences: `nav` and `extra.social` are defined in this file and in
# mkdocs.ja.yml, and must never also appear in the base.
INHERIT: ./mkdocs.base.yml

docs_dir: docs/en
site_dir: site
site_url: "https://cri-middleware.github.io/SSPlayerForGodot/"
site_description: "A Godot Engine integration for SpriteStudio 7"

theme:
  # Drives the UI string translations and the `html lang` attribute.
  language: en

extra:
  # English builds to the site root, so the root of the whole multi-locale site is right
  # here. The language selector adds this in front of its target; see
  # overrides/partials/alternate.html.
  site_root_prefix: ""
  # Footer icons. Keep to destinations that outlive any single release. Mirrored, with
  # translated labels, in mkdocs.ja.yml - add or reorder an icon in both files.
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/cri-middleware
      name: cri-middleware on GitHub
    - icon: material/web
      link: https://www.webtech.co.jp/spritestudio/
      name: OPTPiX SpriteStudio
    # Keep the handle here in sync with `twitter:site` in overrides/main.html.
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/spritestudio
      name: SpriteStudio on X

# Paths are locale-relative and identical to the ones in mkdocs.ja.yml; only the labels
# differ. When you add, move, or rename a page, edit both files.
nav:
  - 🏠 Home: index.md
  - 🚀 Setup:
      - Installation: setup/install.md
      - Build Guide: setup/build.md
  - 🎬 Workflow:
      - Basic Usage: workflow/usage_basic.md
      - Asset Import & Editor Integration: workflow/usage_asset_pipeline.md
      - Scripting & Events: workflow/usage_scripting.md
      - AnimationPlayer Integration: workflow/animation_player.md
      - Exporting Your Project: workflow/export.md
  - ⚙️ Advanced Topics:
      - CLI Conversion & CI/CD: workflow/import.md
      - Performance Tuning & Advanced Settings: workflow/tips.md
  - 📖 API Reference:
      - SpriteStudioPlayer2D: api/player.md
      - Resource Classes: api/resource.md
  - ⚠️ Limitations & Scope: limitations.md
  - 🔄 Migration Guide: migration_from_v1.md