MinerU/mkdocs.yml

site_name: MinerU
site_url: https://opendatalab.github.io/MinerU
repo_name: opendatalab/MinerU
repo_url: https://github.com/opendatalab/MinerU

theme:
  icon:
    repo: fontawesome/brands/github
  name: material
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      scheme: default
      primary: black
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  logo: images/logo.png
  favicon: images/logo.png
  features:
    - content.tabs.link
    - content.code.annotate
    - content.code.copy
    - navigation.expand
    - navigation.footer
    - navigation.tabs
    - navigation.sections
    - navigation.path
    - navigation.indexes
    - navigation.top
    - navigation.tracking
    - search.suggest
    - toc.follow

extra:
  analytics:
    provider: google
    property: G-44K480CC48
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/opendatalab/MinerU
      name: GitHub
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/OpenDataLab_AI
      name: X-Twitter
    - icon: fontawesome/brands/discord
      link: https://discord.gg/Tdedn9GTXq
      name: Discord
    - icon: fontawesome/brands/weixin
      link: https://mineru.net/community-portal/?aliasId=3c430f94
      name: WeChat
    - icon: material/email
      link: mailto:OpenDataLab@pjlab.org.cn
      name: E-mail

copyright: © 2024 - 2025 MinerU. All Rights Reserved.

extra_css:
  - stylesheets/extra.css

nav:
  - Home:
    - "MinerU": index.md
    - Quick Start:
      - Quick Start: quick_start/index.md
      - Extension Modules: quick_start/extension_modules.md
      - Docker Deployment: quick_start/docker_deployment.md
    - Usage:
      - Usage: usage/index.md
      - Quick Usage: usage/quick_usage.md
      - Tiers and Runtimes: usage/tiers.md
      - Python SDK: usage/sdk_api.md
      - V1 HTTP API: usage/http_api.md
      - Legacy Platforms (MinerU <4): usage/compatibility.md
      - Model Source: usage/model_source.md
      - CLI Tools: usage/cli_tools.md
      - Advanced CLI Parameters: usage/advanced_cli_parameters.md
    - Reference:
      - Reference: reference/index.md
      - Migration to 4.0: reference/migration_4.md
      - Output File Format: reference/output_files.md
      - Changelog: reference/changelog.md
    - FAQ:
      - FAQ: faq/index.md
    - Demo:
      - Demo: demo/index.md
  - Quick Start:
    - Quick Start: quick_start/index.md
    - Extension Modules: quick_start/extension_modules.md
    - Docker Deployment: quick_start/docker_deployment.md
  - Usage:
    - Usage: usage/index.md
    - Quick Usage: usage/quick_usage.md
    - Tiers and Runtimes: usage/tiers.md
    - Python SDK: usage/sdk_api.md
    - V1 HTTP API: usage/http_api.md
    - Legacy Platforms (MinerU <4): usage/compatibility.md
    - Model Source: usage/model_source.md
    - CLI Tools: usage/cli_tools.md
    - Advanced CLI Parameters: usage/advanced_cli_parameters.md
  - Reference:
    - Reference: reference/index.md
    - Migration to 4.0: reference/migration_4.md
    - Output File Format: reference/output_files.md
    - Changelog: reference/changelog.md
  - FAQ:
    - FAQ: faq/index.md
  - Demo:
    - Demo: demo/index.md


plugins:
  - search
  - i18n:
      reconfigure_material: true
      docs_structure: folder
      fallback_to_default: true
      reconfigure_search: true
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: zh
          name: 中文
          build: true
          nav_translations:
            Home: 主页
            Quick Start: 快速入门
            Extension Modules: 扩展模块安装
            Docker Deployment: Docker部署
            Usage: 使用指南
            Quick Usage: 基础使用
            CLI Tools: 命令行工具
            Tiers and Runtimes: 档位与运行环境
            Python SDK: Python SDK
            V1 HTTP API: V1 HTTP API
            Legacy Platforms (MinerU <4): 旧平台适配（MinerU <4）
            Migration to 4.0: 迁移到 4.0
            Model Source: 模型源配置
            Advanced CLI Parameters: 命令行进阶参数
            FAQ: 常见问题解答
            Reference: 参考资料
            Output File Format: 输出文件格式
            Changelog: 更新日志
            Demo: 在线演示
  - mkdocs-video

markdown_extensions:
  - admonition
  - pymdownx.details
  - attr_list
  - def_list
  - gfm_admonition
  - pymdownx.highlight:
      use_pygments: true
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true