espilon-docs/mkdocs.yml at main · Espilon-Net/espilon-docs · 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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
site_name: Espilon Documentation
site_description: ESP32 Embedded Agent Framework for Security Research
site_author: Espilon Project Contributors
site_url: https://espilon-project.io

repo_name: Espilon-Net/espilon-source
repo_url: https://github.com/Espilon-Net/espilon-source
edit_uri: edit/main/docs/

theme:
  name: material
  language: en
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link

  icon:
    repo: fontawesome/brands/github
    logo: material/radio-tower

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Espilon-Net/espilon-docs
    - icon: fontawesome/solid/paper-plane
      link: mailto:contact@espilon-project.io

  alternate:
    - name: English
      link: /
      lang: en
    - name: Français
      link: /fr/
      lang: fr

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 3
  - 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:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - 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

plugins:
  - search:
      lang:
        - en
        - fr
  - i18n:
      docs_structure: folder
      fallback_to_default: true
      reconfigure_material: true
      reconfigure_search: true
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: fr
          name: Français
          build: true
          nav_translations:
            Home: Accueil
            Getting Started: Démarrage
            Overview: Aperçu
            Architecture: Architecture
            Quick Start: Démarrage Rapide
            Installation: Installation
            Hardware: Matériel
            Supported Boards: Cartes Supportées
            Configuration: Configuration
            Menuconfig Guide: Guide Menuconfig
            Network Settings: Paramètres Réseau
            Tools: Outils
            Flasher: Flasher
            C2 Server: Serveur C2
            Modules: Modules
            Command Reference: Référence des Commandes
            Use Cases: Cas d'Usage
            Examples & Scenarios: Exemples & Scénarios
            Security: Sécurité
            Best Practices: Bonnes Pratiques
            Reference: Référence
            Troubleshooting: Dépannage
            FAQ: FAQ
            About: À Propos
            License: Licence
            ESP32-CAM: ESP32-CAM

nav:
  - Home: index.md

  - Getting Started:
    - Overview: getting-started/overview.md
    - Architecture: getting-started/architecture.md
    - Quick Start: getting-started/quickstart.md
    - Installation: getting-started/installation.md

  - Hardware:
    - Overview: hardware/index.md
    - Supported Boards: hardware/boards.md
    - LilyGO T-Call: hardware/lilygo-tcall.md
    - ESP32-CAM: hardware/esp32-cam.md

  - Configuration:
    - Menuconfig Guide: configuration/menuconfig.md
    - Network Settings: configuration/network.md

  - Tools:
    - Flasher: tools/flasher.md
    - C2 Server: tools/c2-server.md

  - Modules:
    - Overview: modules/index.md
    - Command Reference: modules/commands.md

  - Use Cases:
    - Examples & Scenarios: use-cases/index.md

  - Security:
    - Overview: security/index.md
    - Best Practices: security/best-practices.md

  - Reference:
    - Troubleshooting: reference/troubleshooting.md
    - FAQ: reference/faq.md

  - About:
    - License: about/license.md

copyright: Copyright &copy; 2025 Espilon Project Contributors