docs.rigsofrods.org/mkdocs.yml at master · ryantechdev/docs.rigsofrods.org · 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
site_name: Rigs of Rods documentation
site_description: Rigs of Rods project documentation
site_author: Rigs of Rods Community
site_url: https://docs.rigsofrods.org/

docs_dir: source

repo_name: RigsOfRods/docs.rigsofrods.org
repo_url: https://github.com/RigsOfRods/docs.rigsofrods.org
edit_uri: blob/master/source/

copyright: "Copyright &copy; 2021 Rigs of Rods Community"

theme:
    name: "material"
    favicon: ror-favicon.png
    logo: images/branding/RoR_Logo_TT.png
    palette:
        scheme: slate
        primary: "blue"
        accent: "blue"
    features:
        - instant
        - tabs

extra_css:
    - stylesheets/ror.css

plugins:
    - search # necessary for search to work
    - git-revision-date-localized
    - minify:
          minify_html: true

nav:
    - Home: README.md
    - Gameplay:
          - Installing the game: gameplay/installing-the-game.md
          - Beginner's Guide: gameplay/beginners-guide.md
          - Installing content (mods): gameplay/installing-content.md
          - Controls and configuration: gameplay/controls-config.md
          - Aircraft handling: gameplay/aircraft-handling.md
          - Multiplayer server setup: gameplay/multiplayer-server-setup.md
          - General FAQ: gameplay/general-faq.md
          - Version 2020.01 FAQ: gameplay/version-2020-01-faq.md
          - Jargon: gameplay/jargon.md
    - Tools and tutorials:
          - Installing addons: tools-tutorials/addons.md
          - Blender mesh editing: tools-tutorials/blender-mesh-editing.md
          - Blender beginner: tools-tutorials/blender-beginner.md
          - Editor nodeSnap: tools-tutorials/editor-nodeSnap.md
          - Visual editors: tools-tutorials/visual-editors.md
          - How to contribute to community projects using GitHub: tools-tutorials/contributing-github.md
    - Vehicle creation:
          - Truck file format: vehicle-creation/fileformat-truck.md
          - Soundscript file format: vehicle-creation/fileformat-soundscript.md
          - Alternate skins (skinzips): vehicle-creation/alternate-skins.md
          - Engine: vehicle-creation/engine.md
          - Flares: vehicle-creation/flares.md
          - Flexbody wheels: vehicle-creation/flexbody-wheels.md
          - Aircraft and aerodynamics: vehicle-creation/aircraft-and-aerodynamics.md
          - Rail vehicles: vehicle-creation/rail-vehicles.md
          - Boats: vehicle-creation/boats.md
          - Motorbikes: vehicle-creation/motorbikes.md
          - Tracked vehicles: vehicle-creation/tracked-vehicles.md
          - Vehicle (Node/Beam) concepts: vehicle-creation/vehicle-concepts.md
          - Suspension: vehicle-creation/suspension.md
          - Wheels, axles, steering: vehicle-creation/wheels-axles-steering.md
          - Special components: vehicle-creation/special-components.md
          - Weight tuning: vehicle-creation/weight-tuning.md
          - Making custom dashboard HUD: vehicle-creation/making-custom-hud.md
    - Terrain creation:
          - Intro to terrain creation: terrain-creation/intro.md
          - Terrn2 file format: terrain-creation/terrn2-subsystem.md
          - Converting old terrain to terrn2 format: terrain-creation/terrain-conversion-terrn2.md
          - Editing terrain objects: terrain-creation/editing-terrain-objects.md
          - Object (odef) file format: terrain-creation/object-format.md
          - Collision meshes: terrain-creation/collision-meshes.md
          - L3DT Map Making: terrain-creation/l3dt-map-making.md
          - Shadows: terrain-creation/shadows.md
          - Building rail tracks: terrain-creation/building-rail-tracks.md
          - Race script generator: terrain-creation/race-generator.md
          - Scripting: terrain-creation/scripting.md
          - RAW Heightmaps: terrain-creation/raw-heightmaps.md
          - Alpha splatting: terrain-creation/custom-texture-splatting.md
          - Old (0.3x) terrain file format: terrain-creation/old-terrn-subsystem.md
    - Rules:
          - Terms of Service: rules/terms-of-service.md
          - UNWRITTEN: rules/rules-unwritten.md
          - STOLEN CONTENT: rules/rules-stolen-content.md
          - NICE: rules/rules-nice.md
          - BACKSEAT: rules/rules-backseat.md
          - BEGGING: rules/rules-begging.md
          - USELESS: rules/rules-useless.md
          - SEARCH: rules/rules-search.md
          - GRAMMAR: rules/rules-grammar.md
          - SINGULARITY: rules/rules-singularity.md
          - LINKS: rules/rules-links.md
          - Crash Report Privacy Policy: legal/crash-report-privacy-policy.md
          - Branding: tools-tutorials/branding.md

markdown_extensions:
    - admonition
    - toc:
          permalink: true
    - pymdownx.arithmatex
    - pymdownx.betterem:
          smart_enable: all
    - pymdownx.caret
    - pymdownx.critic
    - pymdownx.details
    - pymdownx.emoji:
          emoji_index: !!python/name:materialx.emoji.twemoji
          emoji_generator: !!python/name:materialx.emoji.to_svg
    - pymdownx.inlinehilite
    - pymdownx.magiclink
    - pymdownx.mark
    - pymdownx.smartsymbols
    - pymdownx.superfences
    - pymdownx.tasklist:
          custom_checkbox: true
    - pymdownx.tabbed
    - pymdownx.tilde