SSPlayerForGodot/mkdocs.yml at develop · SpriteStudio/SSPlayerForGodot · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
site_name: SpriteStudioPlayer for Godot
site_description: "A Godot Engine integration for SpriteStudio 7"
site_author: "CRI Middleware Co., Ltd."
site_url: "https://cri-middleware.github.io/SSPlayerForGodot/"
repo_name: "cri-middleware/SSPlayerForGodot"
repo_url: "https://github.com/cri-middleware/SSPlayerForGodot"
edit_uri: "edit/main/docs/"

theme:
  name: material
  language: en
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue grey
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue grey
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - content.code.copy

plugins:
  - search
  - callouts
  - i18n:
      docs_structure: folder
      languages:
        - locale: en
          name: English
          default: true
          build: true
        - locale: ja
          name: 日本語
          build: true

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
  - 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
  - Migration Guide: migration_from_v1.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets

extra:
  alternate:
    - name: English
      link: ./
      lang: en
    - name: 日本語
      link: ./ja/
      lang: ja