mkdocs.yml

site_name: Vehicle Physics Pro
site_description: Documentation for Vehicle Physics Pro (VPP), a realistic vehicle simulation model for Unity 3D
site_author: Edy (Angel Garcia)
site_url: https://vehiclephysics.com/
# repo_url: https://github.com/EdyJ/vehicle-physics-docs

strict: true
google_analytics: [ 'UA-58719504-1', 'auto' ]

theme:
  name: mkdocs
  custom_dir: 'custom_theme'
  highlightjs: true

# HighlightJS is being configured in (js/highlightjs-setup.js)

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'
  - 'js/highlightjs-setup.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
#  - codehilite		Don't use. Removes code highlight in the server. We're configuring the built-in HighlightJS properly (see js/highlightjs-setup.js)
  - 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
  - Changelog: about/changelog.md
  - Support: about/support.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
  - Extending VPP: user-guide/extending-vpp.md
- Components:
  - Component Guide: components/component-guide.md
  - Vehicle Controller: components/vehicle-controller.md
  - Wheel Collider: components/wheel-collider.md
  - Suspension: components/vehicle-suspension.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
  - Vehicle Toolkit: components/vehicle-toolkit.md
  - Vehicle Joint: components/vehicle-joint.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/other-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
  - How suspensions work: advanced/how-suspensions-work.md
  - Configuring realistic vehicles: advanced/configuring-realistic-vehicles.md
  - Vehicle rigging notes: advanced/vehicle-rigging.md
  - Switch Between VPP Editions: advanced/switch-between-vpp-editions.md