mkdocs.yml

site_name: Ella Core Documentation
site_url: https://docs.ellanetworks.com/
docs_dir: docs
theme:
  name: material
  logo: images/logo.png
  favicon: images/logo.png
  palette:
    primary: custom
  font:
    text: Source Code Pro
  features:
    - navigation.sections
    - navigation.footer
    - content.code.copy
  icon:
    repo: fontawesome/brands/github
extra_css:
  - stylesheets/extra.css
repo_url: https://github.com/ellanetworks/core
repo_name: ellanetworks/core
copyright: Copyright © 2024 Guillaume Belanger
extra:
  generator: false
markdown_extensions: 
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - tables
  - toc:
      permalink: true
nav:
  - Home: index.md
  - Tutorials:
    - Getting Started: tutorials/getting_started.md
    - Running an End-to-End 5G Network: tutorials/end_to_end_network.md
  - How-to Guides:
    - Deploy: how_to/deploy.md
    - Integrate with a Radio: how_to/integrate_with_radio.md
    - Backup and Restore: how_to/backup_and_restore.md
  - Reference:
    - API:
      - Overview: reference/api/overview.md
      - Backup: reference/api/backup.md
      - Authentication: reference/api/auth.md
      - Metrics: reference/api/metrics.md
      - Operator: reference/api/operator.md
      - Profiles: reference/api/profiles.md
      - Radios: reference/api/radios.md
      - Restore: reference/api/restore.md
      - Status: reference/api/status.md
      - Subscribers: reference/api/subscribers.md
      - Users: reference/api/users.md
    - Metrics: reference/metrics.md
    - Configuration File: reference/config_file.md
    - Connectivity: reference/connectivity.md
    - Audit Logs: reference/audit_logs.md
    - TLS: reference/tls.md
    - Data Plane Performance: reference/data_plane_performance.md
    - Supported Radios: reference/supported_radios.md
  - Explanation:
    - Architecture: explanation/architecture.md
    - Subscriber Authentication: explanation/subscriber_authentication.md
    - User Plane Packet processing with eBPF: explanation/user_plane_packet_processing_with_ebpf.md
plugins:
  - search
  - glightbox
  - social:
      cards_layout_options:
        background_color: "#26374a"