Files
MinerU/mkdocs.yml

98 lines
2.5 KiB
YAML

site_name: MinerU
site_url: https://opendatalab.github.io/MinerU
repo_name: opendatalab/MinerU
repo_url: https://github.com/opendatalab/MinerU
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
logo: images/logo.png
favicon: images/logo.svg
features:
- content.tabs.link
- content.code.annotate
- content.code.copy
- navigation.instant
- navigation.instant.progress
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.path
- navigation.indexes
- search.suggest
nav:
- Home:
- "MinerU": index.md
- Quick Start:
- quick_start/index.md
- Extension Modules: quick_start/extension_modules.md
- Docker Deployment: quick_start/docker_deployment.md
- Usage:
- usage/index.md
- CLI Tools: usage/cli_tools.md
- Model Source: usage/model_source.md
- Advanced CLI Parameters: usage/advanced_cli_parameters.md
- Output File Format: usage/output_file.md
- FAQ:
- FAQ: FAQ/index.md
- Known Issues: known_issues.md
- TODO: todo.md
plugins:
- search
- i18n:
docs_structure: folder
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: 使用方法
CLI Tools: 命令行工具
Model Source: 模型源
Advanced CLI Parameters: 命令行参数进阶技巧
FAQ: FAQ
Output File Format: 输出文件格式
Known Issues: 已知问题
TODO: TODO
- mkdocs-video
markdown_extensions:
- gfm_admonition
- pymdownx.highlight:
use_pygments: true
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true