From ef44979b5ce1e59c4583c8e678267ba005af2574 Mon Sep 17 00:00:00 2001 From: Jin Hai Date: Wed, 17 Dec 2025 19:27:47 +0800 Subject: [PATCH] Fix table format warning in Markdown file (#12002) ### What problem does this PR solve? As title ### Type of change - [x] Documentation Update - [x] Refactoring Signed-off-by: Jin Hai --- README.md | 8 ++--- README_id.md | 8 ++--- README_ja.md | 8 ++--- README_ko.md | 8 ++--- README_pt_br.md | 8 ++--- README_tzh.md | 8 ++--- README_zh.md | 8 ++--- SECURITY.md | 4 +-- docs/guides/accessing_admin_ui.md | 6 ++-- .../docs_generator.md | 30 +++++++++---------- .../agent/agent_component_reference/parser.md | 14 ++++----- .../accelerate_agent_question_answering.md | 2 +- .../dataset/configure_knowledge_base.md | 28 ++++++++--------- docs/references/http_api_reference.md | 2 +- docs/references/python_api_reference.md | 18 +++++------ intergrations/firecrawl/INSTALLATION.md | 14 ++++----- intergrations/firecrawl/README.md | 14 ++++----- sandbox/README.md | 4 +-- 18 files changed, 96 insertions(+), 96 deletions(-) diff --git a/README.md b/README.md index 8aa8d0574..ed1e34558 100644 --- a/README.md +++ b/README.md @@ -206,10 +206,10 @@ releases! 🌟 > 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? | -| ----------------- | --------------- | --------------------- | ------------------------ | -| v0.21.1 | ≈9 | ✔️ | Stable release | -| v0.21.1-slim | ≈2 | ❌ | Stable release | +| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? | +|-------------------|-----------------|-----------------------|----------------| +| v0.21.1 | ≈9 | ✔️ | Stable release | +| v0.21.1-slim | ≈2 | ❌ | Stable release | > Starting with `v0.22.0`, we ship only the slim edition and no longer append the **-slim** suffix to the image tag. diff --git a/README_id.md b/README_id.md index 80df82208..4b6794040 100644 --- a/README_id.md +++ b/README_id.md @@ -206,10 +206,10 @@ 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: -| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? | -| ----------------- | --------------- | --------------------- | ------------------------ | -| v0.21.1 | ≈9 | ✔️ | Stable release | -| v0.21.1-slim | ≈2 | ❌ | Stable release | +| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? | +|-------------------|-----------------|-----------------------|----------------| +| v0.21.1 | ≈9 | ✔️ | Stable release | +| v0.21.1-slim | ≈2 | ❌ | Stable release | > Mulai dari `v0.22.0`, kami hanya menyediakan edisi slim dan tidak lagi menambahkan akhiran **-slim** pada tag image. diff --git a/README_ja.md b/README_ja.md index 9a0ee559e..58e2b7a52 100644 --- a/README_ja.md +++ b/README_ja.md @@ -186,10 +186,10 @@ > 注意：`v0.22.0` より前のバージョンでは、embedding モデルを含むイメージと、embedding モデルを含まない slim イメージの両方を提供していました。詳細は以下の通りです： -| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? | -| ----------------- | --------------- | --------------------- | ------------------------ | -| v0.21.1 | ≈9 | ✔️ | Stable release | -| v0.21.1-slim | ≈2 | ❌ | Stable release | +| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? | +|-------------------|-----------------|-----------------------|----------------| +| v0.21.1 | ≈9 | ✔️ | Stable release | +| v0.21.1-slim | ≈2 | ❌ | Stable release | > `v0.22.0` 以降、当プロジェクトでは slim エディションのみを提供し、イメージタグに **-slim** サフィックスを付けなくなりました。 diff --git a/README_ko.md b/README_ko.md index 423847259..f21d461b9 100644 --- a/README_ko.md +++ b/README_ko.md @@ -188,10 +188,10 @@ > 참고: `v0.22.0` 이전 버전에서는 embedding 모델이 포함된 이미지와 embedding 모델이 포함되지 않은 slim 이미지를 모두 제공했습니다. 자세한 내용은 다음과 같습니다: -| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? | -| ----------------- | --------------- | --------------------- | ------------------------ | -| v0.21.1 | ≈9 | ✔️ | Stable release | -| v0.21.1-slim | ≈2 | ❌ | Stable release | +| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? | +|-------------------|-----------------|-----------------------|----------------| +| v0.21.1 | ≈9 | ✔️ | Stable release | +| v0.21.1-slim | ≈2 | ❌ | Stable release | > `v0.22.0`부터는 slim 에디션만 배포하며 이미지 태그에 **-slim** 접미사를 더 이상 붙이지 않습니다. diff --git a/README_pt_br.md b/README_pt_br.md index 7e151ca1a..8d963b284 100644 --- a/README_pt_br.md +++ b/README_pt_br.md @@ -206,10 +206,10 @@ 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: -| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? | -| ----------------- | --------------- | --------------------- | ------------------------ | -| v0.21.1 | ≈9 | ✔️ | Stable release | -| v0.21.1-slim | ≈2 | ❌ | Stable release | +| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? | +|-------------------|-----------------|-----------------------|----------------| +| v0.21.1 | ≈9 | ✔️ | Stable release | +| v0.21.1-slim | ≈2 | ❌ | Stable release | > A partir da `v0.22.0`, distribuímos apenas a edição slim e não adicionamos mais o sufixo **-slim** às tags das imagens. diff --git a/README_tzh.md b/README_tzh.md index df9bd772b..951bad319 100644 --- a/README_tzh.md +++ b/README_tzh.md @@ -205,10 +205,10 @@ > 注意：在 `v0.22.0` 之前的版本，我們會同時提供包含 embedding 模型的映像和不含 embedding 模型的 slim 映像。具體如下： -| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? | -| ----------------- | --------------- | --------------------- | ------------------------ | -| v0.21.1 | ≈9 | ✔️ | Stable release | -| v0.21.1-slim | ≈2 | ❌ | Stable release | +| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? | +|-------------------|-----------------|-----------------------|----------------| +| v0.21.1 | ≈9 | ✔️ | Stable release | +| v0.21.1-slim | ≈2 | ❌ | Stable release | > 從 `v0.22.0` 開始，我們只發佈 slim 版本，並且不再在映像標籤後附加 **-slim** 後綴。 diff --git a/README_zh.md b/README_zh.md index f90e5f3fd..2deb26818 100644 --- a/README_zh.md +++ b/README_zh.md @@ -206,10 +206,10 @@ > 注意：在 `v0.22.0` 之前的版本，我们会同时提供包含 embedding 模型的镜像和不含 embedding 模型的 slim 镜像。具体如下： - | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? | - | ----------------- | --------------- | --------------------- | ------------------------ | - | v0.21.1 | ≈9 | ✔️ | Stable release | - | v0.21.1-slim | ≈2 | ❌ | Stable release | + | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? | + |-------------------|-----------------|-----------------------|----------------| + | v0.21.1 | ≈9 | ✔️ | Stable release | + | v0.21.1-slim | ≈2 | ❌ | Stable release | > 从 `v0.22.0` 开始，我们只发布 slim 版本，并且不再在镜像标签后附加 **-slim** 后缀。 diff --git a/SECURITY.md b/SECURITY.md index 3ccc48b67..7b95ba4cc 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -6,8 +6,8 @@ Use this section to tell people about which versions of your project are currently being supported with security updates. | Version | Supported | -| ------- | ------------------ | -| <=0.7.0 | :white_check_mark: | +|---------|--------------------| +| <=0.7.0 | :white_check_mark: | ## Reporting a Vulnerability diff --git a/docs/guides/accessing_admin_ui.md b/docs/guides/accessing_admin_ui.md index 181cff5ac..aafd6e997 100644 --- a/docs/guides/accessing_admin_ui.md +++ b/docs/guides/accessing_admin_ui.md @@ -13,9 +13,9 @@ The RAGFlow Admin UI is a web-based interface that provides comprehensive system To access the RAGFlow admin UI, append `/admin` to the web UI's address, e.g. `http://[RAGFLOW_WEB_UI_ADDR]/admin`, replace `[RAGFLOW_WEB_UI_ADDR]` with real RAGFlow web UI address. ### Default Credentials -| Username | Password | -|----------|----------| -| `admin@ragflow.io` | `admin` | +| Username | Password | +|--------------------|----------| +| `admin@ragflow.io` | `admin` | ## Admin UI Overview diff --git a/docs/guides/agent/agent_component_reference/docs_generator.md b/docs/guides/agent/agent_component_reference/docs_generator.md index be4efa463..3ed8e342a 100644 --- a/docs/guides/agent/agent_component_reference/docs_generator.md +++ b/docs/guides/agent/agent_component_reference/docs_generator.md @@ -157,12 +157,12 @@ Optional. Text to display as a diagonal watermark across each page. Useful for m The **Docs Generator** component provides the following output variables: -| Variable name | Type | Description | -| ------------- | --------- | --------------------------------------------------------------------------- | -| `file_path` | `string` | The server path where the generated document is saved. | -| `pdf_base64` | `string` | The document content encoded in base64 format. | -| `download` | `string` | JSON containing download information for the chat interface. | -| `success` | `boolean` | Indicates whether the document was generated successfully. | +| Variable name | Type | Description | +|---------------|-----------|--------------------------------------------------------------| +| `file_path` | `string` | The server path where the generated document is saved. | +| `pdf_base64` | `string` | The document content encoded in base64 format. | +| `download` | `string` | JSON containing download information for the chat interface. | +| `success` | `boolean` | Indicates whether the document was generated successfully. | ### Displaying the download button @@ -189,15 +189,15 @@ The **Docs Generator** includes intelligent font handling for international cont ### Supported scripts -| Script | Unicode Range | Font Used | -| ------ | ------------- | --------- | -| Chinese (CJK) | U+4E00–U+9FFF | STSong-Light | -| Japanese (Hiragana/Katakana) | U+3040–U+30FF | HeiseiMin-W3 | -| Korean (Hangul) | U+AC00–U+D7AF | HYSMyeongJo-Medium | -| Arabic | U+0600–U+06FF | CID font fallback | -| Hebrew | U+0590–U+05FF | CID font fallback | -| Devanagari (Hindi) | U+0900–U+097F | CID font fallback | -| Thai | U+0E00–U+0E7F | CID font fallback | +| Script | Unicode Range | Font Used | +|------------------------------|---------------|--------------------| +| Chinese (CJK) | U+4E00–U+9FFF | STSong-Light | +| Japanese (Hiragana/Katakana) | U+3040–U+30FF | HeiseiMin-W3 | +| Korean (Hangul) | U+AC00–U+D7AF | HYSMyeongJo-Medium | +| Arabic | U+0600–U+06FF | CID font fallback | +| Hebrew | U+0590–U+05FF | CID font fallback | +| Devanagari (Hindi) | U+0900–U+097F | CID font fallback | +| Thai | U+0E00–U+0E7F | CID font fallback | ### Font installation diff --git a/docs/guides/agent/agent_component_reference/parser.md b/docs/guides/agent/agent_component_reference/parser.md index 8f4f520b7..ec545ba64 100644 --- a/docs/guides/agent/agent_component_reference/parser.md +++ b/docs/guides/agent/agent_component_reference/parser.md @@ -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: | File type | File format | -| ------------- | ------------------------ | +|---------------|--------------------------| | PDF | PDF | | Spreadsheet | XLSX, XLS, CSV | | Image | PNG, JPG, JPEG, GIF, TIF | @@ -97,9 +97,9 @@ 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. -| Variable name | Type | -| ------------- | ------------------------ | -| `markdown` | `string` | -| `text` | `string` | -| `html` | `string` | -| `json` | `Array` | +| Variable name | Type | +|---------------|-----------------| +| `markdown` | `string` | +| `text` | `string` | +| `html` | `string` | +| `json` | `Array` | diff --git a/docs/guides/agent/best_practices/accelerate_agent_question_answering.md b/docs/guides/agent/best_practices/accelerate_agent_question_answering.md index 1161588bd..809905198 100644 --- a/docs/guides/agent/best_practices/accelerate_agent_question_answering.md +++ b/docs/guides/agent/best_practices/accelerate_agent_question_answering.md @@ -45,7 +45,7 @@ Click the light bulb icon above the *current* dialogue and scroll down the popup | Item name | Description | -| ----------------- |-----------------------------------------------------------------------------------------------| +|-------------------|-----------------------------------------------------------------------------------------------| | Total | Total time spent on this conversation round, including chunk retrieval and answer generation. | | Check LLM | Time to validate the specified LLM. | | Create retriever | Time to create a chunk retriever. | diff --git a/docs/guides/dataset/configure_knowledge_base.md b/docs/guides/dataset/configure_knowledge_base.md index 464a5ca36..649dba9cc 100644 --- a/docs/guides/dataset/configure_knowledge_base.md +++ b/docs/guides/dataset/configure_knowledge_base.md @@ -39,20 +39,20 @@ 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: -| **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 | -| 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 | -| Manual | | PDF | -| Table | The table mode uses TSI technology for efficient data parsing. | XLSX, XLS (Excel 97-2003), CSV/TXT | -| Paper | | PDF | -| Book | | DOCX, PDF, TXT | -| Laws | | DOCX, PDF, TXT | -| Presentation | | PDF, PPTX | -| Picture | | JPEG, JPG, PNG, TIF, GIF | -| One | Each document is chunked in its entirety (as one). | DOCX, XLSX, XLS (Excel 97-2003), PDF, TXT | -| Tag | The dataset functions as a tag set for the others. | XLSX, CSV/TXT | +| **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 | +| 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 | +| Manual | | PDF | +| Table | The table mode uses TSI technology for efficient data parsing. | XLSX, XLS (Excel 97-2003), CSV/TXT | +| Paper | | PDF | +| Book | | DOCX, PDF, TXT | +| Laws | | DOCX, PDF, TXT | +| Presentation | | PDF, PPTX | +| Picture | | JPEG, JPG, PNG, TIF, GIF | +| One | Each document is chunked in its entirety (as one). | DOCX, XLSX, XLS (Excel 97-2003), PDF, TXT | +| Tag | The dataset functions as a tag set for the others. | XLSX, CSV/TXT | You can also change a file's chunking method on the **Files** page. diff --git a/docs/references/http_api_reference.md b/docs/references/http_api_reference.md index b2197fc76..e7859209e 100644 --- a/docs/references/http_api_reference.md +++ b/docs/references/http_api_reference.md @@ -14,7 +14,7 @@ A complete reference for RAGFlow's RESTful API. Before proceeding, please ensure --- | Code | Message | Description | -| ---- | --------------------- | -------------------------- | +|------|-----------------------|----------------------------| | 400 | Bad Request | Invalid request parameters | | 401 | Unauthorized | Unauthorized access | | 403 | Forbidden | Access denied | diff --git a/docs/references/python_api_reference.md b/docs/references/python_api_reference.md index 26717cac9..a70053e98 100644 --- a/docs/references/python_api_reference.md +++ b/docs/references/python_api_reference.md @@ -22,15 +22,15 @@ pip install ragflow-sdk --- -| Code | Message | Description | -|------|----------------------|-----------------------------| -| 400 | Bad Request | Invalid request parameters | -| 401 | Unauthorized | Unauthorized access | -| 403 | Forbidden | Access denied | -| 404 | Not Found | Resource not found | -| 500 | Internal Server Error| Server internal error | -| 1001 | Invalid Chunk ID | Invalid Chunk ID | -| 1002 | Chunk Update Failed | Chunk update failed | +| Code | Message | Description | +|------|-----------------------|----------------------------| +| 400 | Bad Request | Invalid request parameters | +| 401 | Unauthorized | Unauthorized access | +| 403 | Forbidden | Access denied | +| 404 | Not Found | Resource not found | +| 500 | Internal Server Error | Server internal error | +| 1001 | Invalid Chunk ID | Invalid Chunk ID | +| 1002 | Chunk Update Failed | Chunk update failed | --- diff --git a/intergrations/firecrawl/INSTALLATION.md b/intergrations/firecrawl/INSTALLATION.md index cf64682ed..3c600a5c5 100644 --- a/intergrations/firecrawl/INSTALLATION.md +++ b/intergrations/firecrawl/INSTALLATION.md @@ -81,13 +81,13 @@ pip install ragflow-firecrawl-integration ## Configuration Options -| Option | Description | Default | Required | -|--------|-------------|---------|----------| -| `api_key` | Your Firecrawl API key | - | Yes | -| `api_url` | Firecrawl API endpoint | `https://api.firecrawl.dev` | No | -| `max_retries` | Maximum retry attempts | 3 | No | -| `timeout` | Request timeout (seconds) | 30 | No | -| `rate_limit_delay` | Delay between requests (seconds) | 1.0 | No | +| Option | Description | Default | Required | +|--------------------|----------------------------------|-----------------------------|----------| +| `api_key` | Your Firecrawl API key | - | Yes | +| `api_url` | Firecrawl API endpoint | `https://api.firecrawl.dev` | No | +| `max_retries` | Maximum retry attempts | 3 | No | +| `timeout` | Request timeout (seconds) | 30 | No | +| `rate_limit_delay` | Delay between requests (seconds) | 1.0 | No | ## Environment Variables diff --git a/intergrations/firecrawl/README.md b/intergrations/firecrawl/README.md index 1b1329e98..c48fff356 100644 --- a/intergrations/firecrawl/README.md +++ b/intergrations/firecrawl/README.md @@ -99,13 +99,13 @@ intergrations/firecrawl/ ## 🔧 **Configuration Options** -| Option | Description | Default | Required | -|--------|-------------|---------|----------| -| `api_key` | Your Firecrawl API key | - | Yes | -| `api_url` | Firecrawl API endpoint | `https://api.firecrawl.dev` | No | -| `max_retries` | Maximum retry attempts | 3 | No | -| `timeout` | Request timeout (seconds) | 30 | No | -| `rate_limit_delay` | Delay between requests (seconds) | 1.0 | No | +| Option | Description | Default | Required | +|--------------------|----------------------------------|-----------------------------|----------| +| `api_key` | Your Firecrawl API key | - | Yes | +| `api_url` | Firecrawl API endpoint | `https://api.firecrawl.dev` | No | +| `max_retries` | Maximum retry attempts | 3 | No | +| `timeout` | Request timeout (seconds) | 30 | No | +| `rate_limit_delay` | Delay between requests (seconds) | 1.0 | No | ## 📊 **API Reference** diff --git a/sandbox/README.md b/sandbox/README.md index 057618cb0..62bc343fa 100644 --- a/sandbox/README.md +++ b/sandbox/README.md @@ -121,7 +121,7 @@ make logs # With Make ### 🧰 Makefile Toolbox | Command | Description | -| ----------------- | ------------------------------------------------ | +|-------------------|--------------------------------------------------| | `make` | Setup, build, launch and test all at once | | `make setup` | Initialize environment and install uv | | `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: | Language | Priority | -| -------- | -------- | +|----------|----------| | Python | High | | Node.js | Medium |