mkdocs.yml

# Project Information
site_name: FlyByWire Simulations Guides
site_url: https://docs.flybywiresim.com
# repo allows for linking main repo to docs
# Uncomment to use
repo_url: https://github.com/flybywiresim/a32nx/
repo_name: flybywiresim/a32nx
edit_uri: "" #removes edit button and icon

# Navigation
# Section Containers are defined by `- Section Name:`
# These should have NO filename.md next to them
# Nestle all pages underneath sections as seen below:
nav:
  - Home: index.md
  - Getting Started:
      - Installation: start/installation.md
      - Converting Liveries: start/convert-liveries.md
      - Porting Custom Camera Views: start/porting-custom-cameras.md
      - Starting the plane: start/first-steps.md
      - Reported Issues: start/reported-issues.md
      - Common Questions: start/faq.md
      - Autopilot / Fly-By-Wire: start/autopilot-fbw.md
  - Airliner Flying Guide:
      - Overview: airliner-flying-guide/overview.md
      - Types of Approaches: airliner-flying-guide/approaches.md
      - Navigation: airliner-flying-guide/navigation.md
      - Understanding Altitude References: airliner-flying-guide/altitude-refs.md
      - METARs/TAFs/ATIS: airliner-flying-guide/weather.md
  - SDK Overview:
      - Docker & Building: sdk/docker.md
      - HTML/JS Gauges: sdk/html-gauges.md
      - WASM Gauges: sdk/wasm-gauges.md
      - XML & RNP: sdk/xml-rnp.md
      - Sounds: sdk/sounds.md
      - Modeling: sdk/modeling.md
      - Texturing: sdk/texturing.md
  - Development Projects:
      - Overview: development-projects/overview.md
      - Blender Plugin: development-projects/blender.md
      - EFB: development-projects/efb.md
      - Installer: development-projects/installer.md
      - Rust SDK: development-projects/msfs-rs.md
      - Website: development-projects/website.md
      - Web API: development-projects/web-api.md
  - A32NX Development:
      - Overview: a32nx-dev/overview.md
      - HTML/JS Code: a32nx-dev/html.md
      - Local SimVars: a32nx-dev/simvars.md
      - XML ModelBehaviors: a32nx-dev/xml.md
      - React Overhaul: a32nx-dev/react.md
  - Donate: donate.md

# Configuration
theme:
  name: material
  # Theme Overhaul configuration. Use with caution.
  # Uncommenting custom_dir requires additional setup.
  #custom_dir: overrides
  logo: assets/images/FBW-Tail.png
  palette:
    scheme: slate
  features:
    - navigation.tabs
    - navigation.instant
  favicon: assets/images/FBW-Tail.png

# Plugins
plugins:
  - search
  - git-revision-date-localized:
      type: date

# Styling Front-end
extra_css:
  - stylesheets/extra.css

# Extra Functions / Customizations
extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/flybywiresim
      name: FlyByWire Simulations on Github
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/FlyByWireSim
      name: FlyByWire Simulations on Twitter
    - icon: fontawesome/brands/facebook
      link: https://www.facebook.com/FlyByWireSimulations
      name: FlyByWire Simulations on Facebook
    - icon: fontawesome/brands/discord
      link: https://discord.com/invite/flybywire
      name: FlyByWire Simulations on Discord
    - icon: fontawesome/brands/twitch
      link: https://www.twitch.tv/flybywiresimulations
      name: FlyByWire Simulations on Twitch
    - icon: fontawesome/brands/youtube
      link: https://youtube.com/flybywiresimulations
      name: FlyByWire Simulations on Youtube

# Additional Markdown Extensions to use bundled icon sets
markdown_extensions:
  - admonition # Makes things pretty
  - pymdownx.superfences # Nestled code
  - attr_list # Add HTML attributes and CSS classes to Markdown elements
  - pymdownx.tabbed # Content tabs
  - pymdownx.details # Additional features to admonition
  - pymdownx.caret # Formatting Extension
  - pymdownx.mark # Formatting Extension
  - pymdownx.tilde # Formatting Extension
  - pymdownx.emoji: # Allows emoji style inline embeds for icons
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg