site_name: TobudOS Documentation
repo_url: https://atomgit.com/tobudos/Document
edit_uri: edit/master/docs/
copyright: Copyright © 2023 TobudOS

theme:
  name: material
  static_templates:
    - 404.html

  # Don't include MkDocs' JavaScript
  include_search_page: false
  search_index_only: true

  # Default values, taken from mkdocs_theme.yml
  language: zh
  features:
    # - announce.dismiss
    #- content.action.edit
    #- content.action.view
    #- content.code.annotate
    #- content.tabs.link
    #- content.tooltips
    # - header.autohide #自动隐藏
    # - navigation.expand # 打开Tab时左侧目录全部展开
    # - navigation.indexes #启用节索引页后，可以将文档直接附加到节
    # - navigation.instant  #自动隐藏
    # - navigation.prune
    # - navigation.sections #启用部分后，顶级部分在边栏中呈现为1220px以上视口的组，但在移动设备上保持原样
    # - navigation.tabs  #顶级部分将呈现在上面视口标题下方的菜单层中，但在移动设备上保持原样
    # - navigation.tabs.sticky  # 启用粘性选项卡后，导航选项卡将锁定在标题下方，并在向下滚动时始终保持可见
    #- navigation.top  # 返回顶部的按钮 在上滑时出现
    #- navigation.expand # 打开Tab时左侧目录全部展开
    #- content.tabs.link   
    #- navigation.tracking  #地址栏中的 URL 将自动更新为在目录中突出显示的活动锚点
    #- search.highlight
    #- search.share
    #- search.suggest
    #- toc.follow
    # - toc.integrate
    
    # - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.indexes
    # - navigation.instant
    # - navigation.prune
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate

  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/favicon.png
  logo: assets/logo.png
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil 
    view: material/eye

# Extensions
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true 
  - tables
  - attr_list
  - md_in_html

nav:
  - 首页: index.md

  - 项目特性简介: Introduction/TobudOS_Brief_Introduction.md

  - 内核移植指南:
    - 基于Keil移植TobudOS内核: Kernel_Porting/Porting_Manual_for_KEIL.md
    - 基于IAR 移植TobudOS内核: Kernel_Porting/Porting_Manual_for_IAR.md
    - 基于GCC 移植TobudOS内核: Kernel_Porting/Porting_Manual_for_GCC.md

  - 内核开发指南:
    - TobudOS内核开发指南: DevelopGuide/Development_Manual.md
    - TobudOS内核API参考手册: DevelopGuide/API_Reference.md
    - TobudOS内核CMSIS适配API指南: DevelopGuide/CMSIS_RTOS_API_Use_Guide.md
    
  - AT模组框架:
    - 无线通信模组AT框架开发指南: AT_Framwork_Guide/AT_Firmware_and_SAL_Firmware_User_Guide.md
    - 基于AT框架和定制模组如何对接腾讯云IoT Explorer平台: AT_Framwork_Guide/How_To_Use_Esp8266_Tencent_Firmware_Connect_Iot_Explorer.md

  - ElfLoader动态加载: ElfLoader_Guide/ElfLoader_Quick_Start.md
  
  - 固件升级:
    - 基于EVB_MX的固件升级指南: OTA_Guide/OTA_Quick_Start_based_EVB_MX_Plus.md
    - 基于EVB_MX的IAP开发指南: OTA_Guide/In_Application_Programming_based_EVB_MX_Plus.md

  - MicroPython开发指南: MicroPython_Guide/BearPi_MicroPython_QuickStart.md
  
  - 文件系统: VFS_Guide/vfs.md
  
  - GUI开发: GUI_Guide/gui.md
  
  - 官方开发套件:
    - EVB_MX+（STM32L4）快速上手: DevelopKit/1.EVB_MX_Plus_Quick_Start.md
    - EVB_LX（GD32V RISC-V）快速上手: DevelopKit/2.EVB_LX_RISC-V_Quick_Start.md
    - EVB_WL（STM32WL）快速上手: DevelopKit/3.EVB_WL_Quick_Start.md
    - EVB_G0（STM32G0）快速上手: DevelopKit/4.EVB_G0_QuickStart.md
    - EVB_AIoT_NXP（RT1062）快速上手: DevelopKit/5.EVB_AIoT_NXP_QuickStart.md
    - EVB_CH32V（CH32V307）快速上手: DevelopKit/6.EVB_CH32V_QuickStart.md
    - EVB_AIoT_STM32（STM32H7）快速上手: DevelopKit/7.EVB_AIoT_STM32_QuickStart.md

plugins:
  - search
  - i18n:
      default_language: zh
      material_alternate: true
      languages:
        zh:
          name: 中文
        en:
          name: English
      nav_translations:
        en:
          首页: Home