"src/vscode:/vscode.git/clone" did not exist on "d71a7b6a24c1d0c0c5e0aa0399f229d16b17d5f4"
mkdocs.yml 2.91 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
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
theme:
  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
32
  logo: images/logo.png
33
  favicon: images/logo.png
Sidney233's avatar
Sidney233 committed
34
35
36
37
  features:
    - content.tabs.link
    - content.code.annotate
    - content.code.copy
38
    - navigation.footer
39
    - navigation.tabs
Sidney233's avatar
Sidney233 committed
40
    - navigation.instant
41
    - navigation.instant.prefetch
Sidney233's avatar
Sidney233 committed
42
43
44
45
    - navigation.instant.progress
    - navigation.sections
    - navigation.path
    - navigation.indexes
46
47
    - navigation.top
    - navigation.tracking
48
    - search.suggest
49
    - toc.follow
Sidney233's avatar
Sidney233 committed
50
51
52
53
54

nav:
  - Home:
    - "MinerU": index.md
    - Quick Start:
55
      - Quick Start: quick_start/index.md
56
57
      - Extension Modules: quick_start/extension_modules.md
      - Docker Deployment: quick_start/docker_deployment.md
Sidney233's avatar
Sidney233 committed
58
    - Usage:
59
      - Usage: usage/index.md
60
61
62
      - CLI Tools: usage/cli_tools.md
      - Model Source: usage/model_source.md
      - Advanced CLI Parameters: usage/advanced_cli_parameters.md
63
    - Reference:
64
65
66
67
68
      - Output File Format: reference/output_files.md
    - FAQ:
      - FAQ: faq/index.md
    - Demo:
      - Demo: demo/index.md
69
  - Reference:
70
71
72
73
74
    - Output File Format: reference/output_files.md
  - FAQ:
    - FAQ: faq/index.md
  - Demo:
    - Demo: demo/index.md
75

Sidney233's avatar
Sidney233 committed
76
77

plugins:
78
  - search
Sidney233's avatar
Sidney233 committed
79
80
  - i18n:
      docs_structure: folder
Sidney233's avatar
Sidney233 committed
81
82
83
      fallback_to_default: true
      reconfigure_material: true
      reconfigure_search: true
Sidney233's avatar
Sidney233 committed
84
85
86
87
88
89
90
91
92
93
94
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: zh
          name: 中文
          build: true
          nav_translations:
            Home: 主页
            Quick Start: 快速开始
95
            Extension Modules: 扩展模块安装
96
            Docker Deployment: Docker部署
Sidney233's avatar
Sidney233 committed
97
            Usage: 使用方法
98
99
            CLI Tools: 命令行工具
            Model Source: 模型源
100
            Advanced CLI Parameters: 命令行进阶参数
101
            FAQ: 常见问题解答
102
            Reference: 参考资料
Sidney233's avatar
Sidney233 committed
103
104
105
106
            Output File Format: 输出文件格式
  - mkdocs-video

markdown_extensions:
107
108
109
  - admonition
  - pymdownx.details
  - attr_list
Sidney233's avatar
Sidney233 committed
110
111
112
  - gfm_admonition
  - pymdownx.highlight:
      use_pygments: true
113
114
115
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true