forked from EdyJ/vehicle-physics-docs
-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathmkdocs.yml
More file actions
90 lines (82 loc) · 3.59 KB
/
mkdocs.yml
File metadata and controls
90 lines (82 loc) · 3.59 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
site_name: Vehicle Physics Pro
site_description: Documentation for Vehicle Physics Pro (VPP), a realistic vehicle simulation model for Unity 3D
site_author: Angel "Edy" Garcia
repo_url: https://github.com/EdyJ/vehicle-physics-docs
strict: true
google_analytics: [ 'UA-58719504-1', 'auto' ]
theme:
name: mkdocs
custom_dir: 'custom_theme'
extra_css: [ 'css/tables.css', 'css/admonitions.css', 'css/fixes.css', 'css/extras.css', 'css/clickview.css', 'css/slick.css', 'css/slick-theme.css', 'css/slick-custom.css' ]
extra_javascript: [ 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS_HTML', 'js/fabric.custom.min.js', 'js/texturecanvas.js', 'js/imagegallery.js', 'js/clickview.js', 'https://unpkg.com/mermaid@8.0.0-rc.8/dist/mermaid.min.js', 'js/drivelinechartcanvas.js', 'js/slick.min.js', 'js/slick-launcher.js' ]
# Extension instructions:
# Install iconfonts and mdx_math from their master, or from the local files in the extensions folder.
#
# iconfonts
# - pip install https://github.com/MadLittleMods/markdown-icons/archive/master.zip
#
# mdx_math
# - pip install https://github.com/mitya57/python-markdown-math/archive/master.zip
markdown_extensions:
- extra
- admonition
- iconfonts:
base: "fa"
prefix: "fa-"
- mdx_math:
enable_dollar_delimiter: True
- toc:
permalink: " #"
nav:
- " ": index.md
- About:
- Features: about/features.md
- Showcase: about/showcase.md
- Demos: about/demos.md
- Licensing: about/licensing.md
- Comparing with other kits: about/comparison.md
- Changelog: about/changelog.md
- User Guide:
- Setting up VPP: user-guide/setting-up-vpp.md
- Getting started: user-guide/getting-started.md
- Creating vehicles: user-guide/vehicle-creation.md
- Configuring vehicles: user-guide/vehicle-setup.md
- 3D models and environment: user-guide/3d-models.md
- Components:
- Component Guide: components/component-guide.md
- Vehicle Controller: components/vehicle-controller.md
- Wheel Collider: components/wheel-collider.md
- Dynamics: components/vehicle-dynamics.md
- Input: components/vehicle-input.md
- Add-ons: components/vehicle-addons.md
- Telemetry: components/vehicle-telemetry.md
- Ground Materials: components/ground-materials.md
- Camera Controller: components/camera-controller.md
- Blocks:
- Inertia: blocks/inertia.md
- Steering: blocks/steering.md
- Brakes: blocks/brakes.md
- Tires: blocks/tires.md
- Driveline: blocks/driveline.md
- Differential: blocks/differential.md
- Torque Splitter: blocks/torque-splitter.md
- Engine: blocks/engine.md
- Clutch: blocks/clutch.md
- Gearbox: blocks/gearbox.md
- Retarder: blocks/retarder.md
- Other blocks: blocks/extra-blocks.md
- Advanced:
- Creating add-on components: advanced/custom-addons.md
- Creating custom vehicles: advanced/custom-vehicles.md
- Creating custom blocks: advanced/custom-blocks.md
- VehicleBehaviour reference: advanced/vehiclebehaviour-reference.md
- VehicleBase reference: advanced/vehiclebase-reference.md
- Block reference: advanced/block-reference.md
- Data Bus reference: advanced/databus-reference.md
- Miscelaneous topics explained: advanced/misc-topics-explained.md
- Vehicle inertia: advanced/vehicle-inertia.md
- How suspensions work: advanced/how-suspensions-work.md
- Configuring realistic vehicles: advanced/configuring-realistic-vehicles.md
- Vehicle rigging notes: advanced/vehicle-rigging.md
- GIT Repository setup: advanced/git-repository-setup.md
- Source Code vs. SDK: advanced/source-code-vs-sdk.md