site_name: SplitterMR Docs
repo_url: https://github.com/andreshere00/Splitter_MR
repo_name: andreshere00/Splitter_MR
theme:
  name: material
  logo: assets/splitter_mr_logo_reduced_white.svg
  icon:
    repo: fontawesome/brands/git-alt
  features:
    - content.code.copy
  palette: 
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/brightness-7 
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Home: index.md
  - Developer Guide: 
    - Overview: api_reference/api_reference.md
    - Readers: api_reference/reader.md
    - Splitters: api_reference/splitter.md
    - Vision models: api_reference/model.md
    - Embedding models: api_reference/embedding.md
  - Examples:
    - Overview: examples/examples.md
    - Reading:
      - Read PDFs without VLMs: examples/pdf/pdf_without_vlm.md
      - Read PDFs using VLMs: examples/pdf/pdf_with_vlm.md
      - Read files with VanillaReader using VLMs: examples/pdf/pdf_vanilla.md
      - Read files with Docling using VLMs: examples/pdf/pdf_docling.md
      - Read files with MarkItDown using VLMs: examples/pdf/pdf_markitdown.md
    - Text-based splitting:
      - Split by grammatical groups: examples/text/fixed_splitter.md
      - Split by characters recursively: examples/text/recursive_character_splitter.md
      - Split by tokens: examples/text/token_splitter.md
      - Split by pages: examples/text/paged_splitter.md
      - Split by semantic similarity: examples/text/semantic_splitter.md
    - Schema-based splitting:
      - Split by HTML Tags: examples/schema/html_tag_splitter.md
      - Split by Code: examples/schema/code_splitter.md
      - Split JSON recursively: examples/schema/json_splitter.md
      - Split tables by rows or columns: examples/schema/row_column_splitter.md
      - Split Markdown and HTML files by headers: examples/schema/header_splitter.md
  - CHANGELOG: CHANGELOG.md

extra_javascript:
  - javascripts/katex.js
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js

extra_css:
  - https://unpkg.com/katex@0/dist/katex.min.css
  - assets/extra.css

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_root_heading: false
            show_root_full_path: false
            heading_level: 5

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - codehilite:
      guess_lang: false
      linenums: false
      pygments_style: default
  - toc:
      permalink: true