EnSim/mkdocs.yml at main · SpaceEngineerSS/EnSim · 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
# MkDocs Configuration for EnSim Documentation
# Build with: mkdocs build
# Serve locally: mkdocs serve

site_name: EnSim Documentation
site_url: https://ensim.io/docs
site_author: EnSim Contributors
site_description: >-
  Professional Rocket Engine & Flight Simulation Platform.
  NASA CEA validated thermochemical equilibrium and 6-DOF trajectory simulation.

# Repository
repo_name: ensim/ensim
repo_url: https://github.com/SpaceEngineerSS/EnSim
edit_uri: edit/main/docs/

# Copyright
copyright: Copyright &copy; 2024-2026 EnSim Contributors

# Theme Configuration
theme:
  name: material
  language: en

  palette:
    # Dark mode (default)
    - scheme: slate
      primary: cyan
      accent: cyan
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

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

  font:
    text: Inter
    code: JetBrains Mono

  icon:
    repo: fontawesome/brands/github
    logo: material/rocket-launch

  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - search.share
    - content.tabs.link
    - content.code.copy
    - content.code.annotate
    - toc.follow

# Plugins
plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details

# Extra JavaScript for math
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

# Extra CSS
extra_css:
  - stylesheets/extra.css

# Extra configuration
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/SpaceEngineerSS/EnSim
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/ensim/

  analytics:
    provider: google
    property: G-XXXXXXXXXX

  version:
    provider: mike

# Navigation
nav:
  - Home: index.md
  - Getting Started: getting-started/index.md
  - User Guide: user-guide/index.md
  - Theory: theory/index.md
  - API Reference:
    - Overview: api/index.md
    - chemistry: api/core/chemistry.md
    - propulsion: api/core/propulsion.md
  - Validation: VALIDATION.md