nextpilot-flight-control/mkdocs.yml at main · nextpilot/nextpilot-flight-control · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
site_name: NextPilot User Guide (Preview)
site_url: http://docs.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-2026 <a href="https://docs.nextpilot.org">NextPilot Development Team</a>,
  Maintained by <a href="https://github.com/comerlater">LaterComer</a> <br />本文档采用
  <a href="https://creativecommons.org/licenses/by/4.0/">CC BY 4.0</a> 国际协议, 开放共享、转载、修改、商用,
  但请保留署名来源

exclude_docs: |
  aboutus/roadmap.md

not_in_nav: |
  /**/SUMMARY.md
  /**/README.md

theme:
  name: material
  custom_dir: docs/overrides
  favicon: favicon.png
  logo: favicon.png
  features:
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.indexes
    - navigation.top
    - navigation.path
    # - navigation.footer
    - search.highlightsearch
    - 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:
      lang: [zh, en]
  - tags
  - autorefs
  - awesome-nav
  # - 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: zh
          name: 简体中文
          default: true
          build: true
        - locale: en
          name: English
          build: !ENV [CI, false]
      reconfigure_material: true
  - mike:
      enabled: !ENV [CI, false]
  - git-revision-date-localized:
      enabled: !ENV [CI, false]
      enable_creation_date: true

extra_css:
  - stylesheets/home.css

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://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js