site_name: Kelora
site_description: Scriptable log processor with embedded Rhai scripting
site_url: https://dloss.github.io/kelora/
repo_url: https://github.com/dloss/kelora
repo_name: dloss/kelora

theme:
  name: material
  logo: kelora-logo.svg
  favicon: kelora-logo.svg
  palette:
    # Light/dark mode toggle
    - scheme: default
      primary: white
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant # Fast page loads
    - navigation.tracking # Update URL with scroll
    - navigation.tabs # Top-level tabs
    - navigation.sections # Expand sections
    - search.suggest # Search suggestions
    - search.highlight # Highlight search terms
    - content.code.copy # Copy code blocks
    - content.code.annotate # Annotate code with numbers

plugins:
  - search:
      lang: en
  - mike:
      version_selector: true
      alias_type: symlink
  - markdown-exec:
      ansi: required

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.snippets:
      base_path: [examples]
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

extra_css:
  - stylesheets/ansi-colors.css

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/dloss/kelora

nav:
  - Home: index.md
  - Quickstart: quickstart.md
  - Tutorials:
      - Overview: tutorials/index.md
      - Basics: tutorials/basics.md
      - Introduction to Rhai: tutorials/intro-to-rhai.md
      - Working with Time: tutorials/working-with-time.md
      - Metrics and Tracking: tutorials/metrics-and-tracking.md
      - Begin and End Stages: tutorials/begin-end-stages.md
      - Advanced Scripting: tutorials/advanced-scripting.md
      - Parsing Custom Formats: tutorials/parsing-custom-formats.md
      - Span Aggregation: tutorials/span-aggregation.md
      - Configuration and Reusability: tutorials/configuration-and-reusability.md
  - How-To Guides:
      - Overview: how-to/index.md
      - Debug Issues Systematically: how-to/debug-issues.md
      - Triage Production Errors: how-to/find-errors-in-logs.md
      - Analyze Web Traffic: how-to/analyze-web-traffic.md
      - Build a Service Health Snapshot: how-to/monitor-application-health.md
      - Investigate Syslog Sources: how-to/parse-syslog-files.md
      - Choose a Multiline Strategy: how-to/handle-multiline-stacktraces.md
      - Sanitize Logs Before Sharing: how-to/extract-and-mask-sensitive-data.md
      - Pseudonymize Identifiers for Analytics: how-to/pseudonymize-identifiers-for-analytics.md
      - Prepare CSV Exports for Analytics: how-to/process-csv-data.md
      - Flatten Nested JSON for Analysis: how-to/fan-out-nested-structures.md
      - Design Streaming Alerts: how-to/build-streaming-alerts.md
      - Process Archives at Scale: how-to/batch-process-archives.md
      - Roll Up Logs with Span Windows: how-to/span-aggregation-cookbook.md
      - Integrate Kelora with External Tools: how-to/integrate-external-tools.md
      - Power-User Techniques: how-to/power-user-techniques.md
  - Concepts:
      - Overview: concepts/index.md
      - Processing Architecture: concepts/pipeline-model.md
      - Events and Fields: concepts/events-and-fields.md
      - Scripting Stages: concepts/scripting-stages.md
      - Error Handling: concepts/error-handling.md
      - Multiline Strategies: concepts/multiline-strategies.md
      - Performance Model: concepts/performance-model.md
      - Performance Comparisons: concepts/performance-comparisons.md
      - Benchmark Results: concepts/benchmark-results.md
      - Configuration System: concepts/configuration-system.md
  - Reference:
      - Overview: reference/index.md
      - Glossary: glossary.md
      - Common Errors: reference/common-errors.md
      - CLI Reference: reference/cli-reference.md
      - Format Reference: reference/formats.md
      - Time Reference: reference/time-reference.md
      - Function Reference: reference/functions.md
      - Script Variables Reference: reference/script-variables.md
      - Rhai Cheatsheet: reference/rhai-cheatsheet.md
      - Exit Codes: reference/exit-codes.md
