VulkanW3DViewer/mkdocs.yml at main · ViTeXFTW/VulkanW3DViewer · 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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
# MkDocs configuration for VulkanW3DViewer
site_name: VulkanW3DViewer
site_description: Modern Vulkan-based renderer for W3D format files from Command & Conquer Generals
site_author: ViTeXFTW
site_url: https://vitexftw.github.io/VulkanW3DViewer/

# Repository
repo_name: ViTeXFTW/VulkanW3DViewer
repo_url: https://github.com/ViTeXFTW/VulkanW3DViewer

# Copyright
copyright: Copyright &copy; 2026 ViTeXFTW - MIT License

# Theme configuration
theme:
  name: material

  # Color palette - Vulkan-inspired red/dark theme
  palette:
    # Dark mode (default)
    - scheme: slate
      primary: red
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

    # Light mode
    - scheme: default
      primary: red
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

  # Features
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - toc.follow

  # Icons
  icon:
    repo: fontawesome/brands/github

  # Custom fonts
  font:
    text: Roboto
    code: Roboto Mono

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Plugins
plugins:
  - search

# Navigation structure
nav:
  - Home: index.md
  - Getting Started:
    - getting-started/index.md
    - Installation: getting-started/installation.md
    - Building: getting-started/building.md
    - Quick Start: getting-started/quick-start.md
  - User Guide:
    - user-guide/index.md
    - Loading Models: user-guide/loading-models.md
    - Navigation Controls: user-guide/navigation-controls.md
    - User Interface: user-guide/user-interface.md
    - Command Line: user-guide/command-line.md
  - Architecture:
    - architecture/index.md
    - Project Structure: architecture/project-structure.md
    - Core Layer: architecture/core-layer.md
    - W3D Parser: architecture/w3d-parser.md
    - Rendering: architecture/rendering.md
    - UI System: architecture/ui-system.md
  - W3D Format:
    - w3d-format/index.md
    - Overview: w3d-format/overview.md
    - Chunk Types: w3d-format/chunk-types.md
    - Meshes: w3d-format/meshes.md
    - Hierarchies: w3d-format/hierarchies.md
    - Animations: w3d-format/animations.md
    - HLod: w3d-format/hlod.md
  - Development:
    - development/index.md
    - Branching Strategy: development/branching-strategy.md
    - Code Style: development/code-style.md
    - Testing: development/testing.md
    - Contributing: development/contributing.md
    - Publishing Docs: development/publishing-docs.md
  - API Reference:
    - api/index.md

# Extra configuration
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ViTeXFTW/VulkanW3DViewer

  generator: false

# Extra CSS for custom styling
extra_css:
  - stylesheets/extra.css