HkbEditor/mkdocs.yml at main · ndahn/HkbEditor · 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
111
112
113
114
115
116
117
site_name: HkbEditor
repo_url: https://github.com/ndahn/HkbEditor
site_url: https://ndahn.github.io/HkbEditor/
site_author: Nikolas Dahn
site_description: "A graphical editor for Havok behaviors. Includes at least one cat :3"
copyright: Nikolas Dahn
theme:
  favicon: assets/images/icon.png
  logo: assets/images/icon.png
  name: material
  custom_dir: docs/overrides
  font:
    text: Noto Sans
  features:
    - announce.dismiss
    - content.code.copy
    - header.autohide
    - navigation.tabs
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.tabs
    - navigation.tracking
    - navigation.top
    - search.highlight
    - search.share
    - search.suggest
  palette:
    - scheme: slate
      primary: amber
      accent: pink

nav:
  - Home: index.md
  - Behaviors: anatomy.md
  - HowTo:
    - First Steps: howto/first_steps.md
    - Basic Use: howto/basics.md
    - Behaviors & HKS: howto/hks.md
    - Tools:
      - Event Listener: howto/tools/event_listener.md
      - Mirror Skeleton: howto/tools/mirror_skeleton.md
  - Templates:
    - Overview: templates/overview.md
    - Contributing: templates/contributing.md
    - ER:
      - Ash of War: templates/er/ash_of_war.md
      - Dodge Stutter Fix: templates/er/dodge_stutter_fix.md
      - Evasion: templates/er/evasion.md
      - Game Event (Player): templates/er/game_event_player.md
      - Game Event (NPC): templates/er/game_event_npc.md
      #- Gesture: templates/er/gesture.md
      - Jump: templates/er/jump.md
      - Jump Attack Type: templates/er/jump_attack.md
      - NPC Attack Slots: templates/er/npc_attack_slots.md
      - NPC Summons: templates/er/npc_summons.md
      - Rolling Arts Stutter Fix: templates/er/rollingarts_stutter_fix.md
      - Stance Move Type: templates/er/stance_move_type.md
      - Throw Attack (Attacker): templates/er/throw_attack_attacker.md
      - Throw Attack (Victim): templates/er/throw_attack_victim.md
      #- Usable Item: templates/er/usable_item.md
      - Weapon Moveset: templates/er/weapon_moveset.md
    - SDT:
      - Damage Additive: templates/sdt/damage_additive.md
      - Ground Attack: templates/sdt/ground_attack.md
      - NPC Animations: templates/sdt/npc_animations.md
  - Troubleshooting: troubleshooting.md
  - API Reference

exclude_docs: "!/templates/"

plugins:
  - search
  - mkdocstrings:
      handlers:
          python:
            options:
              docstring_style: numpy
              show_signature_annotations: true
              separate_signature: true
              show_source: false
              show_symbol_type_heading: true
              show_symbol_type_toc: true
              scoped_crossrefs: true
  - api-autonav:
      modules: ["hkb_editor"]
      nav_item_prefix: ""

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      toc_depth: "1-3"
      permalink: true
  # Python Markdown Extensions
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tilde
  - pymdownx.emoji:
      emoji_index: !!python/name:pymdownx.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg