docs/mkdocs.yml at main · AetherInteractiveLtd/docs · 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
site_name: Tina Framework
theme:
  name: material
  favicon: 'assets/icon.png'
  logo: 'assets/docs_icon.png'
  palette:
    scheme: slate
    primary: deep purple
    accent: purple
  features:
  - announce.dismiss
  - content.code.annotate
  - content.tabs.link
  - content.tooltips
  # - header.autohide
  - navigation.expand
  - navigation.indexes
  # - navigation.instant
  # - navigation.prune
  - navigation.sections
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.top
  - navigation.tracking
  - search.highlight
  - search.share
  - search.suggest
  - toc.follow
  - toc.integrate

extra_css:
  - stylesheets/extra.css

repo_url: https://github.com/AetherInteractiveLtd/Tina
repo_name: Aether/Tina

plugins:
  - tags
  - blog:
      enabled: true
      post_date_format: full
      post_url_date_format: yyyy
      post_url_format: '{date}/{slug}'
      authors: true

markdown_extensions:
  - toc:
      toc_depth: 3
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - def_list
  - tables
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - footnotes

nav:
- Home: 'index.md'

- API:
  - 'Getting Started': 'api/api_docs.md'
  - 'API Detail': 'api/coverage.md'
  - 'Tina': 'api/tina.md'
  - 'Condition': 'api/condition.md'
  - 'Process': 'api/process.md'
  - 'EventEmitter': 'api/event_emitter.md'
  - 'EventListener': 'api/event_listener.md'
  - ECS:
    - 'Component': 'api/ecs/component.md'
    - 'Query': 'api/ecs/query.md'
    - 'System': 'api/ecs/system.md'
    - 'World': 'api/ecs/world.md'
  - Extras:
    - 'api/types/manifest.md'

- Tina Guide:
  - 'The Philosophy': 'intro/tina/philosophy.md'
  - 'Getting Started': 'intro/tina/start.md'
  - 'Main Features': 'intro/tina/core.md'

  - Lib:
    - 'Events': 'intro/tina/libraries/events.md'
    - 'Conditions': 'intro/tina/libraries/conditions.md'
    - 'Processes': 'intro/tina/libraries/processes.md'

  - ECS:
    - 'Entity Component System': 'intro/tina/ecs/ecs.md'
    - 'Design Motivation': 'intro/tina/ecs/design.md'
    - 'The Future': 'intro/tina/ecs/future.md'
    - 'Snippets': 'intro/tina/ecs/vs-code-snippets.md'
    - 'Best Practices': 'intro/tina/ecs/best-practices.md'

  - 'Networking': 'intro/tina/libraries/net/net.md'

- Style Guide: 'intro/styleguide.md'

- Blog: 'blog/index.md'