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

6
docs/guides/accessing_admin_ui.md
View File

@ -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

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

@ -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

14
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:
| 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<Object>` |
| Variable name | Type |
|---------------|-----------------|
| `markdown` | `string` |
| `text` | `string` |
| `html` | `string` |
| `json` | `Array<Object>` |

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 |
| ----------------- |-----------------------------------------------------------------------------------------------|
|-------------------|-----------------------------------------------------------------------------------------------|
| 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. |

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

@ -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.