Enigma2DGameEngineDocs/mkdocs.yml at main · EnigmaGameEngine/Enigma2DGameEngineDocs · 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
site_name: Enigma Game Framework
site_description: Official documentation for the Enigma game framework, a C# framework for creating simple games
site_author: MTA

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - search.suggest
    - search.highlight
    - content.code.copy
  palette:
    # Light mode
    - scheme: default
      primary: blue grey
      accent: cyan
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - scheme: slate
      primary: blue grey
      accent: cyan
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - markdown_katex
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.arithmatex:
      generic: true

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

nav:
  - Home: index.md

  - Getting Started:
    - Installation: getting-started/installation.md
    - Building from Source: getting-started/build-source.md
    - Quick Start Guide: getting-started/quickstart.md

  - Core Architecture:
    - Math Library: core/math.md
    - Engine Overview: core/architecture.md
    - Entity Component System: core/ecs.md
    - Service Locator: core/service-locator.md

  - Physics Systems:
    - Overview and setting: systems/physics.md
    - Collision: systems/collision.md
    - Rigidbody: systems/rigidbody.md

  - Graphics:
    - Overview:
    - Camera:
    - Shpaes:
    - Sprite:
    - Text:

  - Scripting:
    - Scripting Overview: scripting/overview.md
    - C# Scripting API: scripting/csharp-scripting.md # Changed from Lua/C++

  - Editor & Tools:
    - Editor Interface: editor/interface.md
    - Asset Pipeline: editor/asset-pipeline.md

  - API Reference: api/reference.md