site_name: Tabularium
site_description: State-of-the-art OCR and fine-tuning for historical documents, made simple for researchers.
site_url: https://nbadino.github.io/tabularium/
repo_url: https://github.com/nbadino/tabularium
repo_name: nbadino/tabularium
edit_uri: edit/main/docs/
copyright: MIT License © Nicolò Badino

docs_dir: docs
exclude_docs: |
  UX_*.md
  OCR_MODEL_ALTERNATIVES.md

theme:
  name: material
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.highlight
    - content.code.copy
    - content.action.edit
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: brown
      accent: amber
      toggle: { icon: material/brightness-7, name: Dark mode }
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: brown
      accent: amber
      toggle: { icon: material/brightness-4, name: Light mode }
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc: { permalink: true }
  - pymdownx.superfences
  - pymdownx.highlight
  - pymdownx.inlinehilite

nav:
  - Home: index.md
  - Getting started:
      - Installation: guide/installation.md
      - Configuration: guide/configuration.md
      - Server deployment: guide/server-deployment.md
      - Upgrading and rollback: guide/upgrading.md
      - Troubleshooting: guide/troubleshooting.md
  - Models:
      - Supported models: models.md
      - Local inference: guide/local-inference.md
      - Cloud GPUs: guide/cloud-gpus.md
      - Fine-tuning: guide/training.md
      - Official training docs: training-official-docs.md
  - Teams: guide/collaboration.md
  - Contributing:
      - Development: guide/development.md