mkdocs.yml 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. site_name: MinerU
  2. site_url: https://opendatalab.github.io/MinerU
  3. repo_name: opendatalab/MinerU
  4. repo_url: https://github.com/opendatalab/MinerU
  5. theme:
  6. name: material
  7. palette:
  8. # Palette toggle for automatic mode
  9. - media: "(prefers-color-scheme)"
  10. scheme: default
  11. primary: black
  12. toggle:
  13. icon: material/brightness-auto
  14. name: Switch to light mode
  15. # Palette toggle for light mode
  16. - media: "(prefers-color-scheme: light)"
  17. scheme: default
  18. primary: black
  19. toggle:
  20. icon: material/brightness-7
  21. name: Switch to dark mode
  22. # Palette toggle for dark mode
  23. - media: "(prefers-color-scheme: dark)"
  24. scheme: slate
  25. primary: black
  26. toggle:
  27. icon: material/brightness-4
  28. name: Switch to system preference
  29. logo: images/logo.png
  30. favicon: images/logo.svg
  31. features:
  32. - content.tabs.link
  33. - content.code.annotate
  34. - content.code.copy
  35. - navigation.instant
  36. - navigation.instant.progress
  37. - navigation.tabs
  38. - navigation.tabs.sticky
  39. - navigation.sections
  40. - navigation.path
  41. - navigation.indexes
  42. - search.suggest
  43. nav:
  44. - Home:
  45. - "MinerU": index.md
  46. - Quick Start:
  47. - quick_start/index.md
  48. - Extension Modules: quick_start/extension_modules.md
  49. - Docker Deployment: quick_start/docker_deployment.md
  50. - Usage:
  51. - usage/index.md
  52. - CLI Tools: usage/cli_tools.md
  53. - Model Source: usage/model_source.md
  54. - Advanced CLI Parameters: usage/advanced_cli_parameters.md
  55. - Output File Format: usage/output_file.md
  56. - FAQ:
  57. - FAQ: FAQ/index.md
  58. - Known Issues: known_issues.md
  59. - TODO: todo.md
  60. plugins:
  61. - search
  62. - i18n:
  63. docs_structure: folder
  64. languages:
  65. - locale: en
  66. default: true
  67. name: English
  68. build: true
  69. - locale: zh
  70. name: 中文
  71. build: true
  72. nav_translations:
  73. Home: 主页
  74. Quick Start: 快速开始
  75. Extension Modules: 扩展模块
  76. Docker Deployment: Docker部署
  77. Usage: 使用方法
  78. CLI Tools: 命令行工具
  79. Model Source: 模型源
  80. Advanced CLI Parameters: 命令行参数进阶技巧
  81. FAQ: FAQ
  82. Output File Format: 输出文件格式
  83. Known Issues: 已知问题
  84. TODO: TODO
  85. - mkdocs-video
  86. markdown_extensions:
  87. - gfm_admonition
  88. - pymdownx.highlight:
  89. use_pygments: true
  90. - pymdownx.superfences
  91. - pymdownx.tasklist:
  92. custom_checkbox: true