Procházet zdrojové kódy

docs: update index.md for improved clarity and structure in troubleshooting sections

myhloli před 4 měsíci
rodič
revize
54d2b12e10
3 změnil soubory, kde provedl 76 přidání a 71 odebrání
  1. 36 36
      docs/en/FAQ/index.md
  2. 35 35
      docs/zh/FAQ/index.md
  3. 5 0
      mkdocs.yml

+ 36 - 36
docs/en/FAQ/index.md

@@ -4,39 +4,39 @@ If your question is not listed, you can also use [DeepWiki](https://deepwiki.com
 
 If you still cannot resolve the issue, you can join the community through [Discord](https://discord.gg/Tdedn9GTXq) or [WeChat](http://mineru.space/s/V85Yl) to communicate with other users and developers.
 
-## 1. Encountered the error `ImportError: libGL.so.1: cannot open shared object file: No such file or directory` in Ubuntu 22.04 on WSL2
-
-The `libgl` library is missing in Ubuntu 22.04 on WSL2. You can install the `libgl` library with the following command to resolve the issue:
-
-```bash
-sudo apt-get install libgl1-mesa-glx
-```
-
-Reference: https://github.com/opendatalab/MinerU/issues/388
-
-
-## 2. Error when installing MinerU on CentOS 7 or Ubuntu 18: `ERROR: Failed building wheel for simsimd`
-
-The new version of albumentations (1.4.21) introduces a dependency on simsimd. Since the pre-built package of simsimd for Linux requires a glibc version greater than or equal to 2.28, this causes installation issues on some Linux distributions released before 2019. You can resolve this issue by using the following command:
-```
-conda create -n mineru python=3.11 -y
-conda activate mineru
-pip install -U "mineru[pipeline_old_linux]"
-```
-
-Reference: https://github.com/opendatalab/MinerU/issues/1004
-
-
-## 3. Missing text information in parsing results when installing and using on Linux systems.
-
-MinerU uses `pypdfium2` instead of `pymupdf` as the PDF page rendering engine in versions >=2.0 to resolve AGPLv3 license issues. On some Linux distributions, due to missing CJK fonts, some text may be lost during the process of rendering PDFs to images.
-To solve this problem, you can install the noto font package with the following commands, which are effective on Ubuntu/Debian systems:
-```bash
-sudo apt update
-sudo apt install fonts-noto-core
-sudo apt install fonts-noto-cjk
-fc-cache -fv
-```
-You can also directly use our [Docker deployment](../quick_start/docker_deployment.md) method to build the image, which includes the above font packages by default.
-
-Reference: https://github.com/opendatalab/MinerU/issues/2915
+??? question "Encountered the error `ImportError: libGL.so.1: cannot open shared object file: No such file or directory` in Ubuntu 22.04 on WSL2"
+
+    The `libgl` library is missing in Ubuntu 22.04 on WSL2. You can install the `libgl` library with the following command to resolve the issue:
+    
+    ```bash
+    sudo apt-get install libgl1-mesa-glx
+    ```
+    
+    Reference: https://github.com/opendatalab/MinerU/issues/388
+
+
+??? question "Error when installing MinerU on CentOS 7 or Ubuntu 18: `ERROR: Failed building wheel for simsimd`"
+
+    The new version of albumentations (1.4.21) introduces a dependency on simsimd. Since the pre-built package of simsimd for Linux requires a glibc version greater than or equal to 2.28, this causes installation issues on some Linux distributions released before 2019. You can resolve this issue by using the following command:
+    ```
+    conda create -n mineru python=3.11 -y
+    conda activate mineru
+    pip install -U "mineru[pipeline_old_linux]"
+    ```
+    
+    Reference: https://github.com/opendatalab/MinerU/issues/1004
+
+
+??? question "Missing text information in parsing results when installing and using on Linux systems."
+
+    MinerU uses `pypdfium2` instead of `pymupdf` as the PDF page rendering engine in versions >=2.0 to resolve AGPLv3 license issues. On some Linux distributions, due to missing CJK fonts, some text may be lost during the process of rendering PDFs to images.
+    To solve this problem, you can install the noto font package with the following commands, which are effective on Ubuntu/Debian systems:
+    ```bash
+    sudo apt update
+    sudo apt install fonts-noto-core
+    sudo apt install fonts-noto-cjk
+    fc-cache -fv
+    ```
+    You can also directly use our [Docker deployment](../quick_start/docker_deployment.md) method to build the image, which includes the above font packages by default.
+    
+    Reference: https://github.com/opendatalab/MinerU/issues/2915

+ 35 - 35
docs/zh/FAQ/index.md

@@ -4,38 +4,38 @@
 
 如果您仍然无法解决问题,您可通过[Discord](https://discord.gg/Tdedn9GTXq)或[WeChat](http://mineru.space/s/V85Yl)加入社区,与其他用户和开发者交流。
 
-### 1. 在WSL2的Ubuntu22.04中遇到报错`ImportError: libGL.so.1: cannot open shared object file: No such file or directory`
-
-WSL2的Ubuntu22.04中缺少`libgl`库,可通过以下命令安装`libgl`库解决:
-
-```bash
-sudo apt-get install libgl1-mesa-glx
-```
-
-参考:https://github.com/opendatalab/MinerU/issues/388
-
-
-### 2. 在 CentOS 7 或 Ubuntu 18 系统安装MinerU时报错`ERROR: Failed building wheel for simsimd`
-
-新版本albumentations(1.4.21)引入了依赖simsimd,由于simsimd在linux的预编译包要求glibc的版本大于等于2.28,导致部分2019年之前发布的Linux发行版无法正常安装,可通过如下命令安装:
-```
-conda create -n mineru python=3.11 -y
-conda activate mineru
-pip install -U "mineru[pipeline_old_linux]"
-```
-
-参考:https://github.com/opendatalab/MinerU/issues/1004
-
-### 3. 在 Linux 系统安装并使用时,解析结果缺失部份文字信息。
-
-MinerU在>=2.0的版本中使用`pypdfium2`代替`pymupdf`作为PDF页面的渲染引擎,以解决AGPLv3的许可证问题,在某些Linux发行版,由于缺少CJK字体,可能会在将PDF渲染成图片的过程中丢失部份文字。
-为了解决这个问题,您可以通过以下命令安装noto字体包,这在Ubuntu/debian系统中有效:
-```bash
-sudo apt update
-sudo apt install fonts-noto-core
-sudo apt install fonts-noto-cjk
-fc-cache -fv
-```
-也可以直接使用我们的[Docker部署](../quick_start/docker_deployment.md)方式构建镜像,镜像中默认包含以上字体包。
-
-参考:https://github.com/opendatalab/MinerU/issues/2915
+??? question "在WSL2的Ubuntu22.04中遇到报错`ImportError: libGL.so.1: cannot open shared object file: No such file or directory`"
+
+    WSL2的Ubuntu22.04中缺少`libgl`库,可通过以下命令安装`libgl`库解决:
+    
+    ```bash
+    sudo apt-get install libgl1-mesa-glx
+    ```
+    
+    参考:https://github.com/opendatalab/MinerU/issues/388
+
+
+??? question "在 CentOS 7 或 Ubuntu 18 系统安装MinerU时报错`ERROR: Failed building wheel for simsimd`"
+
+    新版本albumentations(1.4.21)引入了依赖simsimd,由于simsimd在linux的预编译包要求glibc的版本大于等于2.28,导致部分2019年之前发布的Linux发行版无法正常安装,可通过如下命令安装:
+    ```
+    conda create -n mineru python=3.11 -y
+    conda activate mineru
+    pip install -U "mineru[pipeline_old_linux]"
+    ```
+    
+    参考:https://github.com/opendatalab/MinerU/issues/1004
+
+??? question "在 Linux 系统安装并使用时,解析结果缺失部份文字信息。"
+
+    MinerU在>=2.0的版本中使用`pypdfium2`代替`pymupdf`作为PDF页面的渲染引擎,以解决AGPLv3的许可证问题,在某些Linux发行版,由于缺少CJK字体,可能会在将PDF渲染成图片的过程中丢失部份文字。
+    为了解决这个问题,您可以通过以下命令安装noto字体包,这在Ubuntu/debian系统中有效:
+    ```bash
+    sudo apt update
+    sudo apt install fonts-noto-core
+    sudo apt install fonts-noto-cjk
+    fc-cache -fv
+    ```
+    也可以直接使用我们的[Docker部署](../quick_start/docker_deployment.md)方式构建镜像,镜像中默认包含以上字体包。
+    
+    参考:https://github.com/opendatalab/MinerU/issues/2915

+ 5 - 0
mkdocs.yml

@@ -35,6 +35,8 @@ theme:
     - content.tabs.link
     - content.code.annotate
     - content.code.copy
+    - navigation.footer
+    - navigation.instant.prefetch
     - navigation.instant
     - navigation.instant.progress
     - navigation.tabs
@@ -86,6 +88,9 @@ plugins:
   - mkdocs-video
 
 markdown_extensions:
+  - admonition
+  - pymdownx.details
+  - attr_list
   - gfm_admonition
   - pymdownx.highlight:
       use_pygments: true