mkdocs.yml

site_name: Onager Documentation
site_description: A Graph Analytics Toolbox for DuckDB
repo_url: https://github.com/CogitatorTech/onager
repo_name: CogitatorTech/onager
site_url: https://cogitatortech.github.io/onager/

theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/logo.svg
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github
    annotation: material/arrow-right-circle
  features:
    # Navigation
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - navigation.footer
    - navigation.indexes
    # Table of contents
    - toc.follow
    # Search
    - search.suggest
    - search.highlight
    - search.share
    # Content
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - content.tabs.link
    - content.tooltips
    # Header
    - header.autohide
    - announce.dismiss

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/CogitatorTech/onager
      name: Onager on GitHub
  generator: false
  analytics:
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: Thanks for your feedback! Help us improve by opening an issue.

extra_css:
  - stylesheets/extra.css

plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - tags

nav:
  - Home: index.md
  - Getting Started:
      - Quick Start: getting-started/quickstart.md
  - User Guide:
      - Function Categories:
          - Graph Registry: guide/graph-registry.md
          - Centrality: guide/centrality.md
          - Community Detection: guide/community.md
          - Link Prediction: guide/links.md
          - Graph Metrics: guide/metrics.md
          - Traversal and Paths: guide/traversal.md
          - Graph Generators: guide/generators.md
          - Subgraph Operations: guide/subgraphs.md
          - Parallel Algorithms: guide/parallel.md
          - Approximation Algorithms: guide/approximation.md
          - Minimum Spanning Tree: guide/mst.md
  - Examples:
      - Basic Usage: examples/basic.md
      - Centrality Analysis: examples/centrality.md
      - Community Detection: examples/community.md
      - Link Prediction: examples/links.md
      - Analytics Use Cases: examples/analytics.md
  - API Reference:
      - SQL Functions: reference/sql-functions.md
      - Input Formats: reference/input-formats.md

markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      permalink_title: Anchor link to this section
      toc_depth: 3
  # PyMdownx
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      auto_title: false
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: CogitatorTech
      repo: onager
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      base_path: docs
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

extra_javascript:
  - assets/js/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js