SplashEditDocs/mkdocs.yml at main · LatchGameDev/SplashEditDocs · 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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
site_name: SplashEdit Documentation
site_description: Build PlayStation 1 games using Unity and SplashEdit
site_url: https://psxsplash.github.io/docs/
repo_url: https://github.com/psxsplash/psxsplash
repo_name: psxsplash/psxsplash

theme:
  name: material
  palette:
    - scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - navigation.tabs
    - search.suggest
    - search.highlight
    - content.code.copy
    - toc.follow
  icon:
    repo: fontawesome/brands/github

plugins:
  - search

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.keys
  - tables
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true

extra:
  version:
    provider: mike
    alias: true
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/psxsplash

nav:
  - Home: index.md
  - Getting Started:
    - getting-started/index.md
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quick-start.md
    - Control Panel: getting-started/control-panel.md
    - Building & Running: getting-started/building.md
  - Scene Components:
    - components/index.md
    - Scene Exporter: components/scene-exporter.md
    - Objects & Meshes: components/objects.md
    - Player: components/player.md
    - Textures & VRAM: components/textures.md
    - Navigation & Collision: components/navigation.md
    - Rooms & Portals: components/rooms-portals.md
    - UI System: components/ui.md
    - Custom Fonts: components/fonts.md
    - Audio: components/audio.md
    - Interactables: components/interactables.md
    - Trigger Boxes: components/trigger-boxes.md
    - Cutscenes: components/cutscenes.md
    - Animations: components/animations.md
    - Loading Screens: components/loading-screens.md
  - Lua Scripting:
    - lua/index.md
    - Fixed-Point Math: lua/fixed-point.md
    - Event Callbacks: lua/events.md
    - API Reference: lua/api-reference.md
    - Patterns & Best Practices: lua/patterns.md
  - Tutorials:
    - tutorials/index.md
    - Collectible Pickups: tutorials/collectibles.md
    - NPC Dialogue: tutorials/npc-dialogue.md
    - Animated Doors: tutorials/animated-doors.md
    - Scene Transitions: tutorials/scene-transitions.md
    - Health & Damage: tutorials/health-damage.md
  - Reference:
    - reference/index.md
    - Multi-Scene Projects: reference/multi-scene.md
    - Memory & Performance: reference/memory.md
    - Known Issues: reference/known-issues.md
    - Contributing: reference/contributing.md