mkdocs.yml

site_name: Espilon Documentation
site_description: ESP32 Embedded Agent Framework for Security Research
site_author: Espilon Project Contributors
site_url: https://docs.espilon.net

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

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

nav:
  - Home: index.md

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

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

  - Firmware:
    - Architecture: firmware/index.md
    - Configuration: firmware/configuration.md
    - Flash Layout: firmware/flash-layout.md

  - C3PO:
    - Overview: c3po/index.md
    - Installation: c3po/installation.md
    - Operator Interface: c3po/interface.md
    - Provisioning: c3po/provisioning.md
    - Module Injection: c3po/injection.md
    - Protocol & Crypto: c3po/protocol.md
    - Security Model: c3po/security.md

  - ESPM:
    - Overview: espm/index.md
    - Module Lifecycle: espm/lifecycle.md
    - Writing a Module: espm/writing.md
    - Building & Injecting: espm/building.md
    - Syscall Reference: espm/syscalls.md
    - Security: espm/security.md

  - Modules:
    - Overview: modules/index.md
    - mod_network: modules/mod_network.md
    - mod_recon: modules/mod_recon.md
    - mod_ble: modules/mod_ble.md
    - mod_fakeap: modules/mod_fakeap.md
    - mod_mitm: modules/mod_mitm.md
    - mod_redteam: modules/mod_redteam.md
    - 'mod_hello (template)': modules/mod_hello.md

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

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

  - About:
    - License: about/license.md

copyright: Copyright © 2025 Espilon Project Contributors