ragflow/web
PentaFDevs f9510edbbc
Feature/docs generator (#11858)
### Type of change

- [x] New Feature (non-breaking change which adds functionality)


### What problem does this PR solve?

This PR introduces a new Docs Generator agent component for producing
downloadable PDF, DOCX, or TXT files from Markdown content generated
within a RAGFlow workflow.

### **Key Features**

**Backend**

- New component: DocsGenerator (agent/component/docs_generator.py)
- 
- Markdown → PDF/DOCX/TXT conversion
- 
- Supports tables, lists, code blocks, headings, and rich formatting
- 
- Configurable document style (fonts, margins, colors, page size,
orientation)
- 
- Optional header logo and footer with page numbers/timestamps
- 

**Frontend**

- New configuration UI for the Docs Generator
- 
- Download button integrated into the chat interface
- 
- Output wired to the Message component
- 
- Full i18n support

**Documentation**

Added component guide:
docs/guides/agent/agent_component_reference/docs_generator.md

**Usage**

Add the Docs Generator to a workflow, connect Markdown output from an
upstream component, configure metadata/style, and feed its output into
the Message component. Users will see a document download button
directly in the chat.

**Contributor Note**

We have been following RAGFlow since more than a year and half now and
have worked extensively on personalizing the framework and integrating
it into several of our internal systems. Over the past year and a half,
we have built multiple platforms that rely on RAGFlow as a core
component, which has given us a strong appreciation for how flexible and
powerful the project is.

We also previously contributed the full Italian translation, and we were
glad to see it accepted. This new Docs Generator component was created
for our own production needs, and we believe that it may be useful for
many others in the community as well.

We want to sincerely thank the entire RAGFlow team for the remarkable
work you have done and continue to do. If there are opportunities to
contribute further, we would be glad to help whenever we have time
available. It would be a pleasure to support the project in any way we
can.

If appropriate, we would be glad to be listed among the project’s
contributors, but in any case we look forward to continuing to support
and contribute to the project.

PentaFrame Development Team

---------

Co-authored-by: PentaFrame <info@pentaframe.it>
Co-authored-by: Kevin Hu <kevinhu.sh@gmail.com>
2025-12-12 14:59:43 +08:00
..
.husky
.storybook feat(storybook): Storybook with Calendar and Modal components #9869 (#10626) 2025-10-17 09:58:52 +08:00
public Feat: If a query variable in a data manipulation operator is deleted, a warning message should be displayed to the user. #10427 #11255 (#11384) 2025-11-19 19:10:57 +08:00
src Feature/docs generator (#11858) 2025-12-12 14:59:43 +08:00
.env Remove 'DID YOU KNOW', when start front-end (#10853) 2025-10-28 19:40:58 +08:00
.eslintrc.js Feat: Display AvatarUpload and RAGFlowAvatar in Storybook #9914 (#9920) 2025-09-04 18:02:17 +08:00
.gitignore Feat: Use storybook to display public components. #9914 (#9915) 2025-09-04 17:03:36 +08:00
.npmrc
.prettierignore
.prettierrc
.umirc.ts Feat: Admin UI (#10857) 2025-10-28 22:25:43 +08:00
externals.d.ts
jest-setup.ts
jest.config.ts
package-lock.json Fix:csv parse in Table (#11870) 2025-12-10 16:44:06 +08:00
package.json Fix:csv parse in Table (#11870) 2025-12-10 16:44:06 +08:00
postcss.config.js Feat: Use storybook to display public components. #9914 (#9915) 2025-09-04 17:03:36 +08:00
README.md Update Admin UI user guide docs (#11183) 2025-11-11 20:29:20 +08:00
tailwind.config.js Add task executor bar chart, add system version string (#11155) 2025-11-11 15:20:37 +08:00
tailwind.css Add task executor bar chart, add system version string (#11155) 2025-11-11 15:20:37 +08:00
tsconfig.json
typings.d.ts

Install front-end dependencies

npm install

Launch front-end

npm run dev

The following output confirms a successful launch of the system:

Login to RAGFlow web UI

Open your browser and navigate to:

http://localhost:9222 or http://[YOUR_MACHINE_IP]:9222

Replace [YOUR_MACHINE_IP] with your actual machine IP address (e.g., http://192.168.1.49:9222).

Login to RAGFlow web admin UI

Open your browser and navigate to:

http://localhost:9222/admin or http://[YOUR_MACHINE_IP]:9222/admin

Replace [YOUR_MACHINE_IP] with your actual machine IP address (e.g., http://192.168.1.49:9222/admin).

Shutdown front-end

Ctrl + C or

kill -f "umi dev"