mkdocs.yml

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
repo_url: https://github.com/Espilon-Net
edit_uri: ""

theme:
  name: material
  language: en
  palette:
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

  font:
    text: IBM Plex Sans
    code: IBM Plex Mono

  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
    - icon: fontawesome/solid/paper-plane
      link: mailto:contact@espilon.net

  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
            System: Système
            Network: Réseau
            FakeAP: FakeAP
            Recon Camera: Caméra Recon
            Recon MLAT: MLAT Recon
            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
            ESP32-CAM Troubleshooting: ESP32-CAM Depannage
            Red Team: Red Team
            Honeypot: Pot de Miel
            CAN Bus: Bus CAN
            OTA Updates: Mises à jour OTA
            Deploy System: Système de Déploiement
            Build Manager: Gestionnaire de Build
            C3PO: C3PO
            Control Server: Serveur de Contrôle
            Protocol & Crypto: Protocole & Crypto
            TUI Interface: Interface TUI
            Web Dashboard: Tableau de Bord Web
            API Reference: Référence API
            Deploy System: Système de Déploiement
            Security Model: Modèle de Sécurité

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
    - ESP32-CAM Troubleshooting: hardware/esp32-cam-troubleshooting.md

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

  - C3PO:
    - Control Server: c3po/index.md
    - Installation: c3po/installation.md
    - Protocol & Crypto: c3po/architecture.md
    - TUI Interface: c3po/tui.md
    - Web Dashboard: c3po/dashboard.md
    - API Reference: c3po/api.md
    - Deploy System: c3po/deploy.md
    - Security Model: c3po/security.md

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

  - Modules:
    - Overview: modules/index.md
    - System: modules/system.md
    - Network: modules/network.md
    - FakeAP: modules/fakeap.md
    - Recon Camera: modules/recon-camera.md
    - Recon MLAT: modules/recon-mlat.md
    - Red Team: modules/redteam.md
    - Honeypot: modules/honeypot.md
    - CAN Bus: modules/canbus.md
    - OTA Updates: modules/ota.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 © 2025 Espilon Project Contributors