mkdocs.yml

site_name: bpfman
repo_url: https://github.com/bpfman/bpfman
edit_uri: edit/main/docs
extra_css:
  - stylesheets/extra.css
site_dir: site

theme:
  name: material
  custom_dir: docs/overrides
  language: en
  logo: img/icon/color/bpfman-icon-color.svg
  favicon: img/icon/color/bpfman-icon-color.svg
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.indexes
    - navigation.tabs
    - navigation.tabs.sticky
    - content.code.annotate

extra:
  version:
    provider: mike

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - tables

nav:
  - Introduction: index.md
  - Quick Start: quick-start.md
  - Documentation:
      - bpfman Overview: getting-started/overview.md
      - Setup and Building: getting-started/building-bpfman.md
      - Launching bpfman: getting-started/launching-bpfman.md
      - Deploying Example eBPF Programs On Local Host: getting-started/example-bpf-local.md
      - Deploying Example eBPF Programs On Kubernetes: getting-started/example-bpf-k8s.md
      - Run bpfman From Release Image: getting-started/running-release.md
      - Run bpfman From RPM: getting-started/running-rpm.md
      - CLI Guide: getting-started/cli-guide.md
      - Example eBPF Programs: getting-started/example-bpf.md
      - Troubleshooting: getting-started/troubleshooting.md
  - Developer Documentation:
      - Contributing: governance/CONTRIBUTING.md
      - Reviewing Guide: governance/REVIEWING.md
      - Deploying the bpfman-operator: developer-guide/operator-quick-start.md
      - Developing the bpfman-operator: developer-guide/develop-operator.md
      - Kubernetes CRD API-Reference: developer-guide/api-spec.md
      - eBPF Bytecode Image Specifications: developer-guide/shipping-bytecode.md
      - bpfman Container Images: developer-guide/image-build.md
      - Documentation: developer-guide/documentation.md
      - Linux Capabilities: developer-guide/linux-capabilities.md
      - Logging: developer-guide/logging.md
      - Configuration: developer-guide/configuration.md
      - Testing: developer-guide/testing.md
      - Debugging: developer-guide/debugging.md
      - Releasing: developer-guide/release.md
      - XDP Tutorial: developer-guide/xdp-overview.md
      - Running the Examples as Non-Root on SELinux Distributions: developer-guide/k8s-selinux-distros.md
  - Design:
      - Daemonless: design/daemonless.md
  - Blog:
      - blog/index.md
  - Community:
      - Meetings: governance/MEETINGS.md
      - Governance: governance/GOVERNANCE.md
      - Code of Conduct: governance/CODE_OF_CONDUCT.md
      - Maintainers: governance/MAINTAINERS.md
      - Security: governance/SECURITY.md

plugins:
  - blog:
      # NOTE: configuration options can be found at
      # https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/
      blog_dir: blog
      blog_toc: true
      post_excerpt: required
      post_excerpt_max_authors: 2
      categories_allowed:
        - Community Meeting
        - "2023"
        - "2024"
  - search
  - mike

copyright: Copyright &copy; 2021-2024 The bpfman contributors.<br>The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage</a>.