MinerU/mkdocs.yml at master · opendatalab/MinerU · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
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
    - toc.integrate

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.

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
      - 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
      - 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
    - 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
    - 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: 命令行工具
            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