mkdocs.yml

site_name: 'Binary Ninja Sidekick User Documentation'
copyright: '© Copyright 2015-2024, Vector 35 Inc'
theme:
  name: material
  favicon: 'images/favicon.ico'
  palette:
  - media: "(prefers-color-scheme: light)"
    scheme: default
    primary: red
    accent: grey
    toggle:
      icon: material/toggle-switch-off-outline
      name: Switch to dark mode
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    primary: red
    accent: blue grey
    toggle:
      icon: material/toggle-switch
      name: Switch to light mode
  highlightjs: false
  shortcuts:
    help: 191    # ?
    next: 78     # n
    previous: 80 # p
    search: 191  # ? / /
nav:
  - Home: 'index.md'
  - 'getting-started.md'
  - User's Guide:
    - Introduction: guide/guide.md
    - Indexes Sidebar:
      - Sidekick Version 2.x: guide/indexes.v2.md
      - Sidekick Version 1.x: guide/indexes.md
    - Code Insight Map View: guide/code_insight_map.md
    - "Suggestions Sidebar":
      - guide/suggestions.md
      - Structure Recovery: guide/structures.md
      - guide/variables.md
      - Structure and Field Naming: guide/fields.md
      - Function Naming: guide/function_naming.md
      - Function Descriptions: guide/briefs.md
    - Assistant Sidebar: guide/assistant.md
    - Analysis Workbench Sidebar: guide/analysis_workbench.md
    - LLMOperator Model Catalog Sidebar: guide/llmoperator_model_catalog.md
    - Investigations Sidebar: guide/investigations.md
    - guide/components.md
    - guide/documentation.md
    - guide/code_comment.md
    - Function Callee Naming: guide/function_callee_naming.md
  - "Known Issues":
    - SKI-1: issues/ski-1.md
    - SKI-2: issues/ski-2.md
  - About:
    - Sidekick: 'about/about.md'
    - Legal Terms and Conditions: 'about/legal-terms-and-conditions.md'
    - Open Source: 'about/open-source.md'
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - toc:
      permalink: True
extra_css:
  - docs.css