mkdocs.yml

site_name: OmniSpatialAI
site_author: Gavin Gao
site_url: https://osai.cgabc.xyz/
site_description: All-in-One Spatial AI

repo_url: https://github.com/cggos/OmniSpatialAI
repo_name: cggos/OmniSpatialAI

theme: 
  name: material # readthedocs material
  # logo: material/library
  favicon: images/favicon.png
  icon:
    repo: fontawesome/brands/git-alt
  nav_style: light
  language: 'zh'
  # palette:
  #   primary: 'light blue'
  #   accent: 'indigo' 
  feature:
    tabs: true
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.prune
    - navigation.indexes
    - navigation.top
    - toc.follow
    # - toc.integrate
    - content.code.annotate

extra_javascript:
    - https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js

plugins:
  - search
  # - social
  - tags

markdown_extensions:
  - abbr
  - meta
  - admonition
  - attr_list
  - def_list
  - footnotes
  - toc:
      permalink: true # "#"
      toc_depth: 5
      separator: "_"
      # slugify: !!python/name:pymdownx.slugs.uslugify_cased
  - codehilite:
      guess_lang: true
      linenums: true
  - pymdownx.inlinehilite
  - pymdownx.arithmatex
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.magiclink
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde        
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences: [
        {name: mermaid, class: mermaid}
      ]
  - pymdownx.highlight:
      auto_title: true
      anchor_linenums: true
      linenums_style: pymdownx-inline
  - pymdownx.tabbed:
      alternate_style: true       
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      # emoji_generator: !!python/name:pymdownx.emoji.to_png
  - pymdownx.tasklist:
      custom_checkbox: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/cggos
      name: cggos on GitHub
    - icon: fontawesome/brands/twitter 
      link: https://twitter.com/CGiABC
      name: CGABC on Twitter
        
nav:
  - Home: 'index.md'
  

  - Control System:
    - Overview: control_system/README.md


  - SLAM:
    - Overview: SLAM/README.md

    - SLAM Framework:
      - Overview: SLAM/slam_frameworks/README.md

    - SLAM Odometry:
      - Overview: SLAM/slam_odometry/README.md
      - Visual Odometry: SLAM/slam_odometry/visual_odometry.md

    - SLAM Mapping:
      - Overview: SLAM/slam_mapping/README.md

    - SLAM Loop Closure:
      - Overview: SLAM/slam_loopclosure/README.md
      - Visual Vocabulary: SLAM/slam_loopclosure/visual_vocabulary.md

    - SLAM Benchmarks:
      - Overview: SLAM/slam_benchmark/README.md
      - Datasets: SLAM/slam_benchmark/slam_dataset.md
      - Simulation: SLAM/slam_benchmark/slam_simulation.md

    - SLAM FAQs:
      - Overview: SLAM/slam_qa/slam_faq_index.md
      - SLAM Run Tips: SLAM/slam_qa/slam_run_tips.md
      - SLAM FAQ: SLAM/slam_qa/slam_faq.md
      - Company Q&A: SLAM/slam_qa/slam_faq_company.md
      - FAQ by GaoXiang: SLAM/slam_qa/slam_faq_gx.md
      - MYNTAI Q&A: SLAM/slam_qa/myntai_qa.md


  - GIS:
    - Overview: GIS/README.md


  - Path Planning:
    - Overview: path_planning/README.md


  - ROS:
    - Overview: ros/README.md
    - ROS Matlab: ros/ros_matlab.md
  

  - Simulation:
    - Overview: sim/README.md
    - Gazebo: sim/gazebo.md

  
  - Autonomous Driving:
    - Overview: autonomous_driving/README.md
  

  - XR:
    - Overview: XR/README.md
    
    - Metaverse: 
      - Overview: XR/meta/README.md

    - AR SDK: 
      - Overview: XR/sdk/README.md

    - AR Functions: 
      - Overview: XR/func/README.md
      - Tracking: XR/func/track.md

    - Applications:
      - Overview: XR/app/README.md
      - AR Glass: XR/app/ar_glass.md


  - Robot + X:
    - Robot + XR: robot_xr/README.md