mkdocs.yml 3.61 KB
Newer Older
Sidney233's avatar
Sidney233 committed
1
site_name: MinerU
Sidney233's avatar
Sidney233 committed
2
site_url: https://opendatalab.github.io/MinerU
3
4
5
repo_name: opendatalab/MinerU
repo_url: https://github.com/opendatalab/MinerU

Sidney233's avatar
Sidney233 committed
6
theme:
7
8
  icon:
    repo: fontawesome/brands/github
Sidney233's avatar
Sidney233 committed
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
  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
34
  logo: images/logo.png
35
  favicon: images/logo.png
Sidney233's avatar
Sidney233 committed
36
37
38
39
  features:
    - content.tabs.link
    - content.code.annotate
    - content.code.copy
40
    - navigation.expand
41
    - navigation.footer
42
    - navigation.tabs
Sidney233's avatar
Sidney233 committed
43
44
45
    - navigation.sections
    - navigation.path
    - navigation.indexes
46
47
    - navigation.top
    - navigation.tracking
48
    - search.suggest
49
    - toc.follow
50
    - toc.integrate
Sidney233's avatar
Sidney233 committed
51

52
53
54
55
56
57
58
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/opendatalab/MinerU
      name: GitHub
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/OpenDataLab_AI
59
      name: X-Twitter
60
61
62
63
    - icon: fontawesome/brands/discord
      link: https://discord.gg/Tdedn9GTXq
      name: Discord
    - icon: fontawesome/brands/weixin
64
      link: http://mineru.space/s/V85Yl
65
      name: WeChat
66
    - icon: material/email
67
      link: mailto:OpenDataLab@pjlab.org.cn
68
69
70
71
      name: E-mail

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

Sidney233's avatar
Sidney233 committed
72
73
74
75
nav:
  - Home:
    - "MinerU": index.md
    - Quick Start:
76
      - Quick Start: quick_start/index.md
77
78
      - Extension Modules: quick_start/extension_modules.md
      - Docker Deployment: quick_start/docker_deployment.md
Sidney233's avatar
Sidney233 committed
79
    - Usage:
80
      - Usage: usage/index.md
81
      - Quick Usage: usage/quick_usage.md
82
      - Model Source: usage/model_source.md
83
      - CLI Tools: usage/cli_tools.md
84
      - Advanced CLI Parameters: usage/advanced_cli_parameters.md
85
    - Reference:
86
87
88
89
90
      - Output File Format: reference/output_files.md
    - FAQ:
      - FAQ: faq/index.md
    - Demo:
      - Demo: demo/index.md
91
  - Reference:
92
93
94
95
96
    - Output File Format: reference/output_files.md
  - FAQ:
    - FAQ: faq/index.md
  - Demo:
    - Demo: demo/index.md
97

Sidney233's avatar
Sidney233 committed
98
99

plugins:
100
  - search
Sidney233's avatar
Sidney233 committed
101
  - i18n:
102
      reconfigure_material: true
Sidney233's avatar
Sidney233 committed
103
      docs_structure: folder
Sidney233's avatar
Sidney233 committed
104
105
106
      fallback_to_default: true
      reconfigure_material: true
      reconfigure_search: true
Sidney233's avatar
Sidney233 committed
107
108
109
110
111
112
113
114
115
116
117
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: zh
          name: 中文
          build: true
          nav_translations:
            Home: 主页
            Quick Start: 快速开始
118
            Extension Modules: 扩展模块安装
119
            Docker Deployment: Docker部署
Sidney233's avatar
Sidney233 committed
120
            Usage: 使用方法
121
            Quick Usage: 快速使用
122
123
            CLI Tools: 命令行工具
            Model Source: 模型源
124
            Advanced CLI Parameters: 命令行进阶参数
125
            FAQ: 常见问题解答
126
            Reference: 参考资料
Sidney233's avatar
Sidney233 committed
127
            Output File Format: 输出文件格式
128
            Demo: 在线演示
Sidney233's avatar
Sidney233 committed
129
130
131
  - mkdocs-video

markdown_extensions:
132
133
134
  - admonition
  - pymdownx.details
  - attr_list
Sidney233's avatar
Sidney233 committed
135
136
137
  - gfm_admonition
  - pymdownx.highlight:
      use_pygments: true
138
139
140
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true