mkdocs.yml

site_name: Orb Dynamic Edge Observability
theme:
  name: material
  custom_dir: overrides
  favicon: img/ORB-logo-ring.png
  logo: img/orb_logo_original.png
  font:
    text: Montserrat
  features:
    - navigation.tracking
    - navigation.instant
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.indexes
    - navigation.sections
    - navigation.prune
    - search.suggest
    # - toc.integrate
  icon:
    repo: fontawesome/brands/github
markdown_extensions:
  - abbr
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - toc:
      toc_depth: 3
plugins:
  - search
nav:
  - Home: index.md
  - About: about.md
  - Getting Started: getting_started.md
  - Guides:
      - guides/index.md
      - Edge Networks: guides/edge_networks.md
      - Authoritative DNS: guides/authoritative_dns.md
      - Recursive DNS: guides/recursive_dns.md
      - DHCP Services: guides/dhcp_services.md
      - Network Traffic (Flow): guides/flow.md
      - Response Testing: guides/response_testing.md
  - Documentation:
      - Running Orb Agents: documentation/running_orb_agent.md
      - Configuring Orb Agent: documentation/orb_agent_configs.md
      - Orb Policy Reference: documentation/advanced_policies.md
      - Orb Metrics: documentation/pktvisor_metrics.md
      - Installing Orb control plane: documentation/install.md
      - Orb REST API: api/orb_rest_api.md
  - Community: "contact.md"
repo_url: https://github.com/orb-community/orb
repo_name: orb-community/orb
edit_uri: ""
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/orb-community/orb
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/orbcommunity
    - icon: fontawesome/brands/slack
      link: https://netdev.chat/
    - icon: octicons/mail-24
      link: "mailto:info@netboxlabs.com"
  analytics:
    provider: google
    property: G-XYK19RRHLW
copyright: Copyright &copy; 2024 | <a href="https://netboxlabs.com/privacy/">Privacy Policy</a>
extra_css:
  - stylesheets/extra.css
extra_javascript:
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - javascripts/tablesort.js