mkdocs.yml 2.86 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.footer
41
    - navigation.tabs
Sidney233's avatar
Sidney233 committed
42
    - navigation.instant
43
    - navigation.instant.prefetch
Sidney233's avatar
Sidney233 committed
44
45
46
47
    - navigation.instant.progress
    - navigation.sections
    - navigation.path
    - navigation.indexes
48
49
    - navigation.top
    - navigation.tracking
50
    - search.suggest
51
    - toc.follow
Sidney233's avatar
Sidney233 committed
52
53
54
55
56

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

Sidney233's avatar
Sidney233 committed
78
79

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

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