yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json

site_name: OmniGibson Documentation
repo_name: StanfordVL/OmniGibson
repo_url: https://github.com/StanfordVL/OmniGibson
theme: 
  name: material
  logo: assets/OmniGibson_logo.png
  favicon: assets/OmniGibson_logo.png
  icon:
    repo: fontawesome/brands/git-alt

  features:
    - navigation.tracking
    - navigation.tabs
    - content.code.copy

  extra:
    homepage: https://behavior.stanford.edu

  custom_dir: .overrides

  # color info
  palette:

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      primary: white
      accent: indigo
      scheme: default
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: blue grey
      accent: indigo
      scheme: slate
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path: omnigibson
  - pymdownx.tasklist:
      custom_checkbox: true
  - attr_list
  - md_in_html

# extra plugins
plugins:
  - search
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          paths: [omnigibson]
  # - social
  - gen-files:
      scripts:
      - docs/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - offline

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting_started/installation.md
    - Quickstart: getting_started/quickstart.md
    - Examples: getting_started/examples.md
    - Running on SLURM: getting_started/slurm.md
  - Modules:
    - Overview: modules/overview.md
    - Prims: modules/prims.md
    - Objects: modules/objects.md
    - Object States: modules/object_states.md
    - Robots: modules/robots.md
    - Controllers: modules/controllers.md
    - Sensors: modules/sensors.md
    - Systems: modules/systems.md
    - Scenes: modules/scenes.md
    - Transition Rules: modules/transition_rules.md
    - Simulator: modules/simulator.md
    - Environments: modules/environments.md
  - Tutorials:
    - Demo Collection: tutorials/demo_collection.md
  - API Reference: reference/*
  - Miscellaneous:
    - FAQ: miscellaneous/faq.md
    - Known Issues & Troubleshooting: miscellaneous/known_issues.md
    - Contributing: miscellaneous/contributing.md
    - Changelog: https://github.com/StanfordVL/OmniGibson/releases
    - Contact Us: miscellaneous/contact.md

extra:
  analytics:
    provider: google
    property: G-6L1G6GMR63