mkdocs.yml

# Project information
site_name: PDFMathTranslate
site_url: https://pdf2zh-next.com
site_author: awwaawwa
site_description: PDF scientific paper translation and bilingual comparison.

# Repository
repo_name: PDFMathTranslate-next
repo_url: https://github.com/PDFMathTranslate-next/PDFMathTranslate-next
edit_uri: edit/main/docs/

# Configuration
use_directory_urls: false
theme:
  name: material
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.code.select
    # - content.footnote.tooltips
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.footer
    - navigation.indexes
    # - navigation.instant
    # - navigation.instant.prefetch
    # - navigation.instant.progress
    # - navigation.prune
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  font:
    text: Roboto
    code: Red Hat Mono
  favicon: images/logo_photo.svg
  logo: images/logo_photo.svg

# Plugins
plugins:
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - minify:
      minify_html: true
  - git-authors

  # i18n language support en, zh, zh_TW, ja, ko, fr, de, es, ru, it, pt
  - i18n:
      docs_structure: folder
      reconfigure_material: true
      languages:

        - locale: en
          name: English
          build: true
          theme:
            palette:
              - media: "(prefers-color-scheme)"
              - media: "(prefers-color-scheme: light)"
                scheme: default
                primary: white
              - media: "(prefers-color-scheme: dark)"
                scheme: slate
                primary: black
          default: true

        - locale: zh
          name: 简体中文
          build: true
          theme:
            palette:
              - media: "(prefers-color-scheme)"
              - media: "(prefers-color-scheme: light)"
                scheme: default
                primary: red
              - media: "(prefers-color-scheme: dark)"
                scheme: slate
                primary: pink
          nav_translations:
            Home: 主页
            Getting Start: 快速开始
            Installation: 如何安装
            Command Line: 命令行
            Usage: 如何使用
            Language Code: 语言代码
            Documentation of Translation Services: 翻译服务文档
            Getting Started: 开始使用
            Advanced: 高级选项
            Supported Languages: 支持的语言
            Community: 社区
            FAQ: 常见问题
            Aliyun: 阿里云
            SiliconFlow: 硅基流动
            For Translators: 文档翻译贡献指南

        - locale: zh_TW
          name: 繁體中文
          build: true
          theme:
            language: zh-TW
            palette:
              - media: "(prefers-color-scheme)"
              - media: "(prefers-color-scheme: light)"
                scheme: default
                primary: pink
              - media: "(prefers-color-scheme: dark)"
                scheme: slate
                primary: red
          nav_translations:
            Home: 首頁
            Getting Start: 快速開始
            Installation: 如何安裝
            Command Line: 命令行
            Usage: 如何使用
            Language Code: 語言代碼
            Documentation of Translation Services: 翻譯服務文檔
            Getting Started: 開始使用
            Advanced: 高級選項
            Supported Languages: 支持的語言
            Community: 社區
            FAQ: 常見問題
            Aliyun: 阿里雲
            SiliconFlow: 硅基流動
            For Translators: 文檔翻譯貢獻指南

        - locale: ja
          name: 日本語
          build: true
          theme:
            palette:
              - media: "(prefers-color-scheme)"
              - media: "(prefers-color-scheme: light)"
                scheme: default
                primary: purple
              - media: "(prefers-color-scheme: dark)"
                scheme: slate
                primary: deep-purple
          nav_translations:
            Home: ホーム
            Getting Start: 始め方
            Installation: インストール
            Command Line: コマンドライン
            Usage: 使い方
            Language Code: 言語コード
            Documentation of Translation Services: 翻訳サービスドキュメント
            Getting Started: 開始
            Advanced: 高度な設定
            Supported Languages: サポート言語
            Community: コミュニティ
            FAQ: よくある質問
            For Translators: 文書翻訳貢献ガイド

        - locale: ko
          name: 한국어
          build: true
          theme:
            palette:
              - media: "(prefers-color-scheme)"
              - media: "(prefers-color-scheme: light)"
                scheme: default
                primary: light-blue
              - media: "(prefers-color-scheme: dark)"
                scheme: slate
                primary: blue
          nav_translations:
            Home: 홈
            Getting Start: 시작하기
            Installation: 설치
            Command Line: 명령줄
            Usage: 사용법
            Language Code: 언어 코드
            Documentation of Translation Services: 번역 서비스 문서
            Getting Started: 시작하기
            Advanced: 고급 옵션
            Supported Languages: 지원 언어
            Community: 커뮤니티
            FAQ: 자주 묻는 질문
            For Translators: 문서 번역 기여 가이드

        - locale: fr
          name: Français
          build: true
          theme:
            palette:
              - media: "(prefers-color-scheme)"
              - media: "(prefers-color-scheme: light)"
                scheme: default
                primary: green
              - media: "(prefers-color-scheme: dark)"
                scheme: slate
                primary: teal
          nav_translations:
            Home: Accueil
            Getting Start: Commencer
            Installation: Installation
            Command Line: Ligne de commande
            Usage: Utilisation
            Language Code: Code de langue
            Documentation of Translation Services: Documentation des services de traduction
            Getting Started: Commencer
            Advanced: Options avancées
            Supported Languages: Langues supportées
            Community: Communauté
            FAQ: FAQ
            For Translators: Guide de contribution des traductions

        - locale: de
          name: Deutsch
          build: true
          theme:
            palette:
              - media: "(prefers-color-scheme)"
              - media: "(prefers-color-scheme: light)"
                scheme: default
                primary: lime
              - media: "(prefers-color-scheme: dark)"
                scheme: slate
                primary: light-green
          nav_translations:
            Home: Startseite
            Getting Start: Erste Schritte
            Installation: Installation
            Command Line: Kommandozeile
            Usage: Verwendung
            Language Code: Sprachcode
            Documentation of Translation Services: Dokumentation der Übersetzungsdienste
            Getting Started: Erste Schritte
            Advanced: Erweiterte Optionen
            Supported Languages: Unterstützte Sprachen
            Community: Gemeinschaft
            FAQ: Häufig gestellte Fragen
            For Translators: Guide de contribution des traductions

        - locale: es
          name: Español
          build: true
          theme:
            palette:
              - media: "(prefers-color-scheme)"
              - media: "(prefers-color-scheme: light)"
                scheme: default
                primary: amber
              - media: "(prefers-color-scheme: dark)"
                scheme: slate
                primary: orange
          nav_translations:
            Home: Inicio
            Getting Start: Empezar
            Installation: Instalación
            Command Line: Línea de comandos
            Usage: Uso
            Language Code: Código de idioma
            Documentation of Translation Services: Documentación de servicios de traducción
            Getting Started: Empezar
            Advanced: Opciones avanzadas
            Supported Languages: Idiomas soportados
            Community: Comunidad
            FAQ: Preguntas frecuentes
            For Translators: Guía de contribución de traducciones

        - locale: ru
          name: Русский
          build: true
          theme:
            palette:
              - media: "(prefers-color-scheme)"
              - media: "(prefers-color-scheme: light)"
                scheme: default
                primary: brown
              - media: "(prefers-color-scheme: dark)"
                scheme: slate
                primary: grey
          nav_translations:
            Home: Главная
            Getting Start: Начало работы
            Installation: Установка
            Command Line: Командная строка
            Usage: Использование
            Language Code: Код языка
            Documentation of Translation Services: Документация служб перевода
            Getting Started: Начало работы
            Advanced: Расширенные параметры
            Supported Languages: Поддерживаемые языки
            Community: Сообщество
            FAQ: Часто задаваемые вопросы
            For Translators: Руководство по внесению вклада в переводы

        - locale: it
          name: Italiano
          build: true
          theme:
            palette:
              - media: "(prefers-color-scheme)"
              - media: "(prefers-color-scheme: light)"
                scheme: default
                primary: blue grey
              - media: "(prefers-color-scheme: dark)"
                scheme: slate
                primary: black
          nav_translations:
            Home: Home
            Getting Start: Iniziare
            Installation: Installazione
            Command Line: Riga di comando
            Usage: Utilizzo
            Language Code: Codice lingua
            Documentation of Translation Services: Documentazione dei servizi di traduzione
            Getting Started: Iniziare
            Advanced: Opzioni avanzate
            Supported Languages: Lingue supportate
            Community: Comunità
            FAQ: Domande frequenti
            For Translators: Guida alla contribuzione per le traduzioni

        - locale: pt
          name: Português
          build: true
          theme:
            palette:
              - media: "(prefers-color-scheme)"
              - media: "(prefers-color-scheme: light)"
                scheme: cyan
                primary: 
              - media: "(prefers-color-scheme: dark)"
                scheme: slate
                primary: indigo
          nav_translations:
            Home: Início
            Getting Start: Começar
            Installation: Instalação
            Command Line: Linha de comando
            Usage: Uso
            Language Code: Código do idioma
            Documentation of Translation Services: Documentação dos serviços de tradução
            Getting Started: Começar
            Advanced: Opções avançadas
            Supported Languages: Idiomas suportados
            Community: Comunidade
            FAQ: Perguntas frequentes
            For Translators: Guia de contribuição para traduções

  - git-revision-date-localized:
      enable_creation_date: true

# Additional configuration
extra:
  status:
    new: Recently added
    deprecated: Deprecated
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/PDFMathTranslate-next/PDFMathTranslate-next
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/pdf2zh-next/

# Extensions
markdown_extensions:

  # Python Markdown
  - github-callouts
  - markdown_include.include
  - def_list
  - admonition

  # Python Markdown Extensions
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.blocks.caption
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true

not_in_nav: |
  /tutorials/**/*.md


# Page tree
nav:
  - Home: index.md
  - Getting Started: 
    - Getting Start: getting-started/getting-started.md
    - Installation:
      - Windows EXE: getting-started/INSTALLATION_winexe.md  
      - Docker: getting-started/INSTALLATION_docker.md       
      - UV: getting-started/INSTALLATION_uv.md               
    - Usage:
      - Command Line: getting-started/USAGE_commandline.md
      - WebUI: getting-started/USAGE_webui.md
      - guaguastandup/zotero-pdf2zh: https://github.com/guaguastandup/zotero-pdf2zh
  - Advanced: 
    - Advanced: advanced/advanced.md
    - Language Code: advanced/Language-Codes.md
    - Documentation of Translation Services: advanced/Documentation-of-Translation-Services.md
    - Translation Services:
      - Aliyun: advanced/TranslationServices/Aliyun.md
      - SiliconFlow: advanced/TranslationServices/SiliconFlow.md
  - Supported Languages: supported_languages.md
  - API: advanced/API/python.md
  - FAQ: FAQ.md
  - Community:
    - Contribution-Guide: community/Contribution-Guide.md
    - For Translators: community/Translate-Contribution-Guide.md