pengjunjie/ragflow
1
0
Fork 1
mirror of https://github.com/infiniflow/ragflow.git synced 2025-12-20 04:39:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix table format warning in Markdown file (#12002)

Browse Source 
### What problem does this PR solve?

As title

### Type of change

- [x] Documentation Update
- [x] Refactoring

Signed-off-by: Jin Hai <haijin.chn@gmail.com>
This commit is contained in:
Jin Hai
2025-12-17 19:27:47 +08:00
committed by GitHub
parent d38f8a1562
commit ef44979b5c
18 changed files with 96 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -207,7 +207,7 @@ releases! 🌟
> Note: Prior to `v0.22.0`, we provided both images with embedding models and slim images without embedding models. Details as follows: > Note: Prior to `v0.22.0`, we provided both images with embedding models and slim images without embedding models. Details as follows:
| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? | | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
| ----------------- | --------------- | --------------------- | ------------------------ | |-------------------|-----------------|-----------------------|----------------|
| v0.21.1 | &approx;9 | ✔️ | Stable release | | v0.21.1 | &approx;9 | ✔️ | Stable release |
| v0.21.1-slim | &approx;2 | ❌ | Stable release | | v0.21.1-slim | &approx;2 | ❌ | Stable release |

2
README_id.md
View File

@ -207,7 +207,7 @@ Coba demo kami di [https://demo.ragflow.io](https://demo.ragflow.io).
> Catatan: Sebelum `v0.22.0`, kami menyediakan image dengan model embedding dan image slim tanpa model embedding. Detailnya sebagai berikut: > Catatan: Sebelum `v0.22.0`, kami menyediakan image dengan model embedding dan image slim tanpa model embedding. Detailnya sebagai berikut:
| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? | | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
| ----------------- | --------------- | --------------------- | ------------------------ | |-------------------|-----------------|-----------------------|----------------|
| v0.21.1 | &approx;9 | ✔️ | Stable release | | v0.21.1 | &approx;9 | ✔️ | Stable release |
| v0.21.1-slim | &approx;2 | ❌ | Stable release | | v0.21.1-slim | &approx;2 | ❌ | Stable release |

2
README_ja.md
View File

@ -187,7 +187,7 @@
> 注意：`v0.22.0` より前のバージョンでは、embedding モデルを含むイメージと、embedding モデルを含まない slim イメージの両方を提供していました。詳細は以下の通りです： > 注意：`v0.22.0` より前のバージョンでは、embedding モデルを含むイメージと、embedding モデルを含まない slim イメージの両方を提供していました。詳細は以下の通りです：
| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? | | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
| ----------------- | --------------- | --------------------- | ------------------------ | |-------------------|-----------------|-----------------------|----------------|
| v0.21.1 | &approx;9 | ✔️ | Stable release | | v0.21.1 | &approx;9 | ✔️ | Stable release |
| v0.21.1-slim | &approx;2 | ❌ | Stable release | | v0.21.1-slim | &approx;2 | ❌ | Stable release |

2
README_ko.md
View File

@ -189,7 +189,7 @@
> 참고: `v0.22.0` 이전 버전에서는 embedding 모델이 포함된 이미지와 embedding 모델이 포함되지 않은 slim 이미지를 모두 제공했습니다. 자세한 내용은 다음과 같습니다: > 참고: `v0.22.0` 이전 버전에서는 embedding 모델이 포함된 이미지와 embedding 모델이 포함되지 않은 slim 이미지를 모두 제공했습니다. 자세한 내용은 다음과 같습니다:
| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? | | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
| ----------------- | --------------- | --------------------- | ------------------------ | |-------------------|-----------------|-----------------------|----------------|
| v0.21.1 | &approx;9 | ✔️ | Stable release | | v0.21.1 | &approx;9 | ✔️ | Stable release |
| v0.21.1-slim | &approx;2 | ❌ | Stable release | | v0.21.1-slim | &approx;2 | ❌ | Stable release |

2
README_pt_br.md
View File

@ -207,7 +207,7 @@ Experimente nossa demo em [https://demo.ragflow.io](https://demo.ragflow.io).
> Nota: Antes da `v0.22.0`, fornecíamos imagens com modelos de embedding e imagens slim sem modelos de embedding. Detalhes a seguir: > Nota: Antes da `v0.22.0`, fornecíamos imagens com modelos de embedding e imagens slim sem modelos de embedding. Detalhes a seguir:
| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? | | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
| ----------------- | --------------- | --------------------- | ------------------------ | |-------------------|-----------------|-----------------------|----------------|
| v0.21.1 | &approx;9 | ✔️ | Stable release | | v0.21.1 | &approx;9 | ✔️ | Stable release |
| v0.21.1-slim | &approx;2 | ❌ | Stable release | | v0.21.1-slim | &approx;2 | ❌ | Stable release |

2
README_tzh.md
View File

@ -206,7 +206,7 @@
> 注意：在 `v0.22.0` 之前的版本，我們會同時提供包含 embedding 模型的映像和不含 embedding 模型的 slim 映像。具體如下： > 注意：在 `v0.22.0` 之前的版本，我們會同時提供包含 embedding 模型的映像和不含 embedding 模型的 slim 映像。具體如下：
| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? | | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
| ----------------- | --------------- | --------------------- | ------------------------ | |-------------------|-----------------|-----------------------|----------------|
| v0.21.1 | &approx;9 | ✔️ | Stable release | | v0.21.1 | &approx;9 | ✔️ | Stable release |
| v0.21.1-slim | &approx;2 | ❌ | Stable release | | v0.21.1-slim | &approx;2 | ❌ | Stable release |

2
README_zh.md
View File

@ -207,7 +207,7 @@
> 注意：在 `v0.22.0` 之前的版本，我们会同时提供包含 embedding 模型的镜像和不含 embedding 模型的 slim 镜像。具体如下： > 注意：在 `v0.22.0` 之前的版本，我们会同时提供包含 embedding 模型的镜像和不含 embedding 模型的 slim 镜像。具体如下：
| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? | | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
| ----------------- | --------------- | --------------------- | ------------------------ | |-------------------|-----------------|-----------------------|----------------|
| v0.21.1 | &approx;9 | ✔️ | Stable release | | v0.21.1 | &approx;9 | ✔️ | Stable release |
| v0.21.1-slim | &approx;2 | ❌ | Stable release | | v0.21.1-slim | &approx;2 | ❌ | Stable release |

2
SECURITY.md
View File

@ -6,7 +6,7 @@ Use this section to tell people about which versions of your project are
currently being supported with security updates. currently being supported with security updates.
| Version | Supported | | Version | Supported |
| ------- | ------------------ | |---------|--------------------|
| <=0.7.0 | :white_check_mark: | | <=0.7.0 | :white_check_mark: |
## Reporting a Vulnerability ## Reporting a Vulnerability

2
docs/guides/accessing_admin_ui.md
View File

@ -14,7 +14,7 @@ To access the RAGFlow admin UI, append `/admin` to the web UI's address, e.g. `h
### Default Credentials ### Default Credentials
| Username | Password | | Username | Password |
|----------|----------| |--------------------|----------|
| `admin@ragflow.io` | `admin` | | `admin@ragflow.io` | `admin` |
## Admin UI Overview ## Admin UI Overview

4
docs/guides/agent/agent_component_reference/docs_generator.md
View File

@ -158,7 +158,7 @@ Optional. Text to display as a diagonal watermark across each page. Useful for m
The **Docs Generator** component provides the following output variables: The **Docs Generator** component provides the following output variables:
| Variable name | Type | Description | | Variable name | Type | Description |
| ------------- | --------- | --------------------------------------------------------------------------- | |---------------|-----------|--------------------------------------------------------------|
| `file_path` | `string` | The server path where the generated document is saved. | | `file_path` | `string` | The server path where the generated document is saved. |
| `pdf_base64` | `string` | The document content encoded in base64 format. | | `pdf_base64` | `string` | The document content encoded in base64 format. |
| `download` | `string` | JSON containing download information for the chat interface. | | `download` | `string` | JSON containing download information for the chat interface. |
@ -190,7 +190,7 @@ The **Docs Generator** includes intelligent font handling for international cont
### Supported scripts ### Supported scripts
| Script | Unicode Range | Font Used | | Script | Unicode Range | Font Used |
| ------ | ------------- | --------- | |------------------------------|---------------|--------------------|
| Chinese (CJK) | U+4E00–U+9FFF | STSong-Light | | Chinese (CJK) | U+4E00–U+9FFF | STSong-Light |
| Japanese (Hiragana/Katakana) | U+3040–U+30FF | HeiseiMin-W3 | | Japanese (Hiragana/Katakana) | U+3040–U+30FF | HeiseiMin-W3 |
| Korean (Hangul) | U+AC00–U+D7AF | HYSMyeongJo-Medium | | Korean (Hangul) | U+AC00–U+D7AF | HYSMyeongJo-Medium |

4
docs/guides/agent/agent_component_reference/parser.md
View File

@ -18,7 +18,7 @@ Within the configuration panel, you can add multiple parsers and set the corresp
The **Parser** component supports parsing the following file types: The **Parser** component supports parsing the following file types:
| File type | File format | | File type | File format |
| ------------- | ------------------------ | |---------------|--------------------------|
| PDF | PDF | | PDF | PDF |
| Spreadsheet | XLSX, XLS, CSV | | Spreadsheet | XLSX, XLS, CSV |
| Image | PNG, JPG, JPEG, GIF, TIF | | Image | PNG, JPG, JPEG, GIF, TIF |
@ -98,7 +98,7 @@ A Video parser transcribes video files to text. To use this parser, you must fir
The global variable names for the output of the **Parser** component, which can be referenced by subsequent components in the ingestion pipeline. The global variable names for the output of the **Parser** component, which can be referenced by subsequent components in the ingestion pipeline.
| Variable name | Type | | Variable name | Type |
| ------------- | ------------------------ | |---------------|-----------------|
| `markdown` | `string` | | `markdown` | `string` |
| `text` | `string` | | `text` | `string` |
| `html` | `string` | | `html` | `string` |

2
docs/guides/agent/best_practices/accelerate_agent_question_answering.md
View File

@ -45,7 +45,7 @@ Click the light bulb icon above the *current* dialogue and scroll down the popup
| Item name | Description | | Item name | Description |
| ----------------- |-----------------------------------------------------------------------------------------------| |-------------------|-----------------------------------------------------------------------------------------------|
| Total | Total time spent on this conversation round, including chunk retrieval and answer generation. | | Total | Total time spent on this conversation round, including chunk retrieval and answer generation. |
| Check LLM | Time to validate the specified LLM. | | Check LLM | Time to validate the specified LLM. |
| Create retriever | Time to create a chunk retriever. | | Create retriever | Time to create a chunk retriever. |

2
docs/guides/dataset/configure_knowledge_base.md
View File

@ -40,7 +40,7 @@ This section covers the following topics:
RAGFlow offers multiple built-in chunking template to facilitate chunking files of different layouts and ensure semantic integrity. From the **Built-in** chunking method dropdown under **Parse type**, you can choose the default template that suits the layouts and formats of your files. The following table shows the descriptions and the compatible file formats of each supported chunk template: RAGFlow offers multiple built-in chunking template to facilitate chunking files of different layouts and ensure semantic integrity. From the **Built-in** chunking method dropdown under **Parse type**, you can choose the default template that suits the layouts and formats of your files. The following table shows the descriptions and the compatible file formats of each supported chunk template:
| **Template** | Description | File format | | **Template** | Description | File format |
|--------------|-----------------------------------------------------------------------|-----------------------------------------------------------------------------------------------| |--------------|-------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| General | Files are consecutively chunked based on a preset chunk token number. | MD, MDX, DOCX, XLSX, XLS (Excel 97-2003), PPT, PDF, TXT, JPEG, JPG, PNG, TIF, GIF, CSV, JSON, EML, HTML | | General | Files are consecutively chunked based on a preset chunk token number. | MD, MDX, DOCX, XLSX, XLS (Excel 97-2003), PPT, PDF, TXT, JPEG, JPG, PNG, TIF, GIF, CSV, JSON, EML, HTML |
| Q&A | Retrieves relevant information and generates answers to respond to questions. | XLSX, XLS (Excel 97-2003), CSV/TXT | | Q&A | Retrieves relevant information and generates answers to respond to questions. | XLSX, XLS (Excel 97-2003), CSV/TXT |
| Resume | Enterprise edition only. You can also try it out on demo.ragflow.io. | DOCX, PDF, TXT | | Resume | Enterprise edition only. You can also try it out on demo.ragflow.io. | DOCX, PDF, TXT |

2
docs/references/http_api_reference.md
View File

@ -14,7 +14,7 @@ A complete reference for RAGFlow's RESTful API. Before proceeding, please ensure
--- ---
| Code | Message | Description | | Code | Message | Description |
| ---- | --------------------- | -------------------------- | |------|-----------------------|----------------------------|
| 400 | Bad Request | Invalid request parameters | | 400 | Bad Request | Invalid request parameters |
| 401 | Unauthorized | Unauthorized access | | 401 | Unauthorized | Unauthorized access |
| 403 | Forbidden | Access denied | | 403 | Forbidden | Access denied |

4
docs/references/python_api_reference.md
View File

@ -23,12 +23,12 @@ pip install ragflow-sdk
--- ---
| Code | Message | Description | | Code | Message | Description |
|------|----------------------|-----------------------------| |------|-----------------------|----------------------------|
| 400 | Bad Request | Invalid request parameters | | 400 | Bad Request | Invalid request parameters |
| 401 | Unauthorized | Unauthorized access | | 401 | Unauthorized | Unauthorized access |
| 403 | Forbidden | Access denied | | 403 | Forbidden | Access denied |
| 404 | Not Found | Resource not found | | 404 | Not Found | Resource not found |
| 500 | Internal Server Error| Server internal error | | 500 | Internal Server Error | Server internal error |
| 1001 | Invalid Chunk ID | Invalid Chunk ID | | 1001 | Invalid Chunk ID | Invalid Chunk ID |
| 1002 | Chunk Update Failed | Chunk update failed | | 1002 | Chunk Update Failed | Chunk update failed |

2
intergrations/firecrawl/INSTALLATION.md
View File

@ -82,7 +82,7 @@ pip install ragflow-firecrawl-integration
## Configuration Options ## Configuration Options
| Option | Description | Default | Required | | Option | Description | Default | Required |
|--------|-------------|---------|----------| |--------------------|----------------------------------|-----------------------------|----------|
| `api_key` | Your Firecrawl API key | - | Yes | | `api_key` | Your Firecrawl API key | - | Yes |
| `api_url` | Firecrawl API endpoint | `https://api.firecrawl.dev` | No | | `api_url` | Firecrawl API endpoint | `https://api.firecrawl.dev` | No |
| `max_retries` | Maximum retry attempts | 3 | No | | `max_retries` | Maximum retry attempts | 3 | No |

2
intergrations/firecrawl/README.md
View File

@ -100,7 +100,7 @@ intergrations/firecrawl/
## 🔧 **Configuration Options** ## 🔧 **Configuration Options**
| Option | Description | Default | Required | | Option | Description | Default | Required |
|--------|-------------|---------|----------| |--------------------|----------------------------------|-----------------------------|----------|
| `api_key` | Your Firecrawl API key | - | Yes | | `api_key` | Your Firecrawl API key | - | Yes |
| `api_url` | Firecrawl API endpoint | `https://api.firecrawl.dev` | No | | `api_url` | Firecrawl API endpoint | `https://api.firecrawl.dev` | No |
| `max_retries` | Maximum retry attempts | 3 | No | | `max_retries` | Maximum retry attempts | 3 | No |

4
sandbox/README.md
View File

@ -121,7 +121,7 @@ make logs # With Make
### 🧰 Makefile Toolbox ### 🧰 Makefile Toolbox
| Command | Description | | Command | Description |
| ----------------- | ------------------------------------------------ | |-------------------|--------------------------------------------------|
| `make` | Setup, build, launch and test all at once | | `make` | Setup, build, launch and test all at once |
| `make setup` | Initialize environment and install uv | | `make setup` | Initialize environment and install uv |
| `make ensure_env` | Auto-create `.env` if missing | | `make ensure_env` | Auto-create `.env` if missing |
@ -183,7 +183,7 @@ This security model strikes a balance between **robust isolation** and **develop
Currently, the following languages are officially supported: Currently, the following languages are officially supported:
| Language | Priority | | Language | Priority |
| -------- | -------- | |----------|----------|
| Python | High | | Python | High |
| Node.js | Medium | | Node.js | Medium |