edgetx/mkdocs.yml at main · EdgeTX/edgetx · 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
site_name: EdgeTX Developer Documentation
site_url: https://docs.edgetx.org/
repo_url: https://github.com/EdgeTX/edgetx
repo_name: EdgeTX/edgetx
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/images/EdgeTX_logo.png
  favicon: assets/images/EdgeTX_logo.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - md_in_html
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Contributing:
    - Getting Started with Git: contributing/getting-started-with-git.md
    - Workflow for GitHub Noobs: contributing/workflow-for-github-noobs.md
    - Git Command Reference: contributing/some-git-commands.md
  - Building EdgeTX:
    - Overview: building/index.md
    - Online:
      - In a Web Browser (CodeSpaces): building/codespaces.md
    - Windows:
      - Windows (Native): building/windows.md
      - Windows (Docker): building/windows-docker.md
      - WSL: building/linux-wsl.md
    - Linux:
      - Ubuntu 22.04: building/linux-ubuntu-22.04.md
      - Ubuntu 24.04: building/linux-ubuntu-24.04.md
    - macOS:
      - Sequoia / Tahoe: building/macos-sequoia.md
      - Sonoma: building/macos-sonoma.md
      - Catalina: building/macos-catalina.md
    - Reference:
      - Compilation Options: building/compilation-options.md
    - Obsolete:
      - Qt Creator: building/qt-creator.md
  - Hardware Reference:
    - Radio Specifications: hardware/radio-specs.md
    - DMA Mappings:
      - RadioMaster TX16S: hardware/dma-mapping-tx16s.md
      - FlySky NV14: hardware/dma-mapping-nv14.md
    - IRQ Usage:
      - RadioMaster TX16S: hardware/irq-usage-tx16s.md
  - Hardware Mods:
    - Flysky Hall Sticks: mods/flysky-hall-sticks.md
    - Flysky FRM303 Mod for TX16S: mods/flysky-frm303-tx16s.md
    - Flysky PL18 & PL18EV: mods/flysky-pl18.md
    - Flysky NB4+: mods/flysky-nb4plus.md
    - Flashing EdgeTX to Flysky PL18/Paladin-EV: mods/flashing-flysky-pl18.md
  - Troubleshooting:
    - Unbrick Your Radio: troubleshooting/unbrick.md
  - Development:
    - CLI Commands: development/cli-commands.md
    - Control Inputs: development/control-inputs.md
    - External Module Protocols: development/external-module-protocols.md
    - YAML Parser/Generator: development/yaml-parser-generator.md
    - Mixer Synchronisation: development/mixer-synchronisation.md

exclude_docs: |
  README.md

extra_css:
  - assets/stylesheets/extra.css

plugins:
  - search
  - minify:
      minify_html: true

extra:
  version:
    provider: mike
    alias: true
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/EdgeTX/edgetx
    - icon: fontawesome/brands/discord
      link: https://discord.gg/wF9wUKnZ6H