forked from engine-alpha/engine-alpha
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathmkdocs.yml
More file actions
205 lines (183 loc) · 7.58 KB
/
mkdocs.yml
File metadata and controls
205 lines (183 loc) · 7.58 KB
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
site_name: Engine Pi
site_url: https://engine-pi.github.io/engine-pi/
repo_name: Engine Pi
repo_url: https://github.com/engine-pi/engine-pi
# https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#code-actions
edit_uri: edit/main/docs/
theme:
name: material
logo: _assets/logo.svg
font:
text: Cantarell
code: Ubuntu Mono
features:
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages
# index.md in Ordner werden nicht doppelt angezeigt
- navigation.indexes
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#navigation
- navigation.footer
# https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-copy-button
- content.code.copy
# https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-selection-button
- content.code.select
# https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#code-actions
- content.action.edit
# https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#code-actions
# - content.action.view
plugins:
# https://mkdocs-macros-plugin.readthedocs.io/en/latest/
- macros:
# https://mkdocs-macros-plugin.readthedocs.io/en/latest/macros/
module_name: docs/macros
# https://github.com/tuunit/mkdocs-drawio
- drawio
markdown_extensions:
# https://squidfunk.github.io/mkdocs-material/reference/code-blocks/
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#inlinehilite
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
# https://squidfunk.github.io/mkdocs-material/manual/footnotes/
- footnotes
- pymdownx.magiclink
# https://squidfunk.github.io/mkdocs-material/manual/images/
- attr_list
# https://squidfunk.github.io/mkdocs-material/reference/grids/
- md_in_html
# https://facelessuser.github.io/pymdown-extensions/extensions/blocks/plugins/caption/
# /// caption Caption ///
- pymdownx.blocks.caption
# https://squidfunk.github.io/mkdocs-material/reference/admonitions/
- admonition
- pymdownx.details
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#inlinehilite
- pymdownx.inlinehilite
# https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#arithmatex
- pymdownx.arithmatex:
generic: true
extra_css:
- _assets/extra.css
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#arithmatex-mkdocsyml
extra_javascript:
- _assets/mathjax.js
- https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
watch:
- .
# https://www.mkdocs.org/user-guide/writing-your-docs/#configure-pages-and-navigation
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages
nav:
- Handbuch:
- index.md
- Hauptklassen:
- manual/main-classes/index.md
- Controller (Steuerung):
- manual/main-classes/controller/index.md
- manual/main-classes/controller/coordinate-system.md
- manual/main-classes/controller/instant-mode.md
- manual/main-classes/controller/game-loop.md
- manual/main-classes/controller/dialog.md
- manual/main-classes/controller/jukebox.md
- manual/main-classes/scene.md
- manual/main-classes/camera.md
- manual/main-classes/layer.md
- 'Actor (Figur)':
- manual/main-classes/actor/index.md
- manual/main-classes/actor/group.md
# Actor Subklassen in alphabetischer Reihenfolge
- manual/main-classes/actor/animation.md
- manual/main-classes/actor/circle.md
- manual/main-classes/actor/counter.md
- manual/main-classes/actor/grid.md
- manual/main-classes/actor/image-text.md
- manual/main-classes/actor/image.md
- manual/main-classes/actor/line.md
- manual/main-classes/actor/polygon.md
- manual/main-classes/actor/rectangle.md
- manual/main-classes/actor/regular-polygon.md
- manual/main-classes/actor/square.md
- manual/main-classes/actor/star.md
- manual/main-classes/actor/stateful-animation.md
- manual/main-classes/actor/stop-watch.md
- manual/main-classes/actor/text-block.md
- manual/main-classes/actor/text.md
- manual/main-classes/actor/tile-map.md
- manual/main-classes/actor/triangle.md
- manual/main-classes/actor/turtle.md
- events (Ereignissteuerung):
- manual/events/index.md
- manual/events/key-event.md
- manual/events/key-stroke.md
- manual/events/mouse-click.md
- manual/events/collision.md
- manual/events/repeat.md
- manual/events/shortcuts.md
- physics (Physiksimulation):
- manual/physics/index.md
- manual/physics/body-type.md
- manual/physics/gravity.md
- manual/physics/density.md
- manual/physics/restitution.md
- manual/physics/impulse.md
- manual/physics/joints.md
- Ressourcenverwaltung:
- manual/resources/index.md
- manual/resources/colors.md
- manual/resources/fonts.md
- manual/resources/images.md
- manual/resources/sounds/index.md
- manual/resources/config.md
- Projekte:
- manual/projects/index.md
- manual/projects/philosophers.md
- Java:
- manual/java/index.md
# Alphabetische Reihenfolge
- manual/java/design-pattern.md
- manual/java/exceptions.md
- manual/java/foreach.md
- manual/java/ide.md
- manual/java/import.md
- manual/java/index.md
- manual/java/lambda.md
- manual/java/overloading.md
- manual/java/packages.md
- manual/java/super.md
- Entwicklung:
- manual/dev/index.md
- manual/dev/monorepo.md
- manual/dev/design.md
- manual/dev/coding-style.md
- manual/dev/javadoc.md
- manual/dev/mkdocs.md
- manual/dev/setter-getter.md
- manual/dev/versions.md
- manual/dev/tests.md
- manual/dev/go-to-file.md
- manual/dev/screen-recording.md
- manual/dev/logging.md
- manual/dev/graphics2d.md
- API (javadocs): https://engine-pi.github.io/javadocs/pi/package-summary.html
- download.md
extra:
version: 0.47.0
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#generator-notice
generator: false
social:
- icon: fontawesome/brands/github
link: https://github.com/engine-pi/engine-pi
- icon: simple/forgejo
link: https://inf.pirckheimer-gymnasium.de/engine-pi/engine-pi
- icon: fontawesome/brands/java
link: https://engine-pi.github.io/javadocs/pi/package-summary.html
- icon: fontawesome/solid/paper-plane
link: mailto:[email protected]
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#copyright-notice
copyright: Copyright © 2024 - 2026 Josef Friedrich