mkdocs.yml

site_name: NextPilot Flight Control System
site_url: http://www.nextpilot.org
site_author: NextPilot Development Team
site_description: NextPilot, a powerfull, scalable and advanced autopilot.

repo_name: nextpilot-flight-control
repo_url: https://github.com/nextpilot/nextpilot-flight-control/

edit_uri: blob/main/docs/
# edit_uri_template: 'blob/main/docs/{path}'
# remote_branch: gh-pages
# remote_name: origin

docs_dir: docs
site_dir: build/gh-pages

use_directory_urls: false
dev_addr: "127.0.0.1:8063"

copyright: Copyright &copy; 2015-2024 <a href="https://www.nextpilot.org">NextPilot Development Team</a>, Maintained by <a href="https://github.com/comerlater">LaterComer</a>.

# nav:
#     - 主页: index.md
#     - 用户手册:
#       - 入门指南: userguide/getting-started
#     - 开发指南:
#       - 入门指南: develop/getting-started
#       - 核心组件: develop/modules
#       - 飞行仿真: develop/simulation
#       - 分析调试: develop/debugging
#       - 高级功能: develop/advance
#       - 集成测试: develop/testing
#       - 代码贡献: develop/contribute
#     - 关于我们: aboutus

theme:
  name: material
  favicon: favicon.png
  logo: favicon.png
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.indexes
    - navigation.top
    - navigation.path
    - seach.highlight
    - search.suggest
    - search.share
    - toc.follow
  language: zh
  icon:
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16

markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: True
      separator: "_"

  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      use_pygments: false
      linenums: true
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

    # - mdx_gh_links:
    #       user: mkdocs
    #       repo: mkdocs
    # - mkdocs-click
    # - callouts

plugins:
  - search
  - tags
  - autorefs
  - literate-nav:
      nav_file: SUMMARY.md
      implicit_index: false
      tab_length: 2
  # - mkdocstrings:
  #     handlers:
  #       python:
  #         options:
  #           docstring_section_style: list
  #           members_order: source
  #           show_root_heading: true
  #           show_source: false
  #           show_signature_annotations: true
  - i18n:
      docs_structure: suffix
      languages:
        - locale: en
          name: English
          build: true
        - locale: zh
          name: 简体中文
          default: true
          build: true
  # - git-revision-date-localized:
  #     enable_creation_date: true

not_in_nav: |
  /**/SUMMARY.md

extra:
  version:
    method: mike
  generator: false
  alternate:
    # Switch to English
    - name: English
      link: /en/
      lang: en

    # Switch to English
    - name: 简体中文
      link: /zh/
      lang: zh

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js