mkdocs.yml

site_name: OPNsense app for Splunk
edit_uri: edit/main/docs/
repo_url: https://github.com/rba-community/Opnsense_App_for_Splunk
repo_name: rba-community/Opnsense_App_for_Splunk
site_description: >-
  Welcome to the Home of the OPNsense App for Splunk documentation. The OPNsense App for Splunk helps make your firewall data meaningful. Visualize system or security related events recorded by the OPNsense® Firewall. This app requires the OPNsense Add-on for Splunk.

plugins:
  - git-revision-date-localized:
      type: date
      fallback_to_build_date: true
  - search
  - minify:
      minify_html: true

markdown_extensions:
  - toc:
      permalink: true
  - attr_list
  - meta
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - abbr
  - pymdownx.snippets:
      auto_append:
        - includes/abbreviations.md
  - md_in_html
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - def_list
  - footnotes
  - pymdownx.betterem:
      smart_enable: all
  - 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

theme:
  name: material
  logo: images/opn_app_logo.png
  favicon: images/opn_app_logo.png
  icon:
    repo: fontawesome/brands/github
  features:
    # - header.autohide
    - navigation.instant
    - navigation.tabs
    - navigation.sections
    - navigation.top
    # - toc.integrate
    - navigation.tracking
    - content.code.annotate
    - content.code.copy
    - navigation.footer
    - search.suggest
    - search.highlight
    - search.share
    - content.action.edit
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: red
      accent: red
      toggle:
        icon: material/weather-night
        name: Switch to light mode

extra:
  social:
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/groups/12702283/
    - icon: fontawesome/brands/github
      link: https://github.com/rba-community/Opnsense_App_for_Splunk

copyright: Copyright © 2024 The RBA Community

nav:
  - Home: index.md
  - OPNsense App: landing-page.md
  - Getting Started:
      - App Dependencies: getting-started/app-dependencies.md
      - Where to Install: getting-started/where-to-install.md
      - Configure:
          - Setup Data Model Acceleration: getting-started/configure/configure-dma.md
          - Update Macros: getting-started/configure/configure-macros.md
  - Reference:
      - Search Macros: reference/reference-macros.md
      - Scheduled Searches: reference/reference-searches.md
      - Changelog:
          - Release Notes: reference/releases/index.md
          - Release History: reference/releases/release-history.md