- forum-solved-export: 3539 个已解决话题(问题+全部对话+采纳回答),含索引 - rdk-docs-export: 21 个文档子站 ~3430 篇 Markdown(源码仓库/抓取/反解析三种方式) - kb-eval: 352 条 RAG 检索评测集(答案全部锚定文档、多轮子代理交叉审计), 含检索/出题/校验工具与子代理提示词模板,支持增量扩产 - pipeline: 论坛枚举导出、文档抓取反解析、覆盖率统计全部脚本(可重跑)
English| 简体中文
Welcome to this project! This document will help you quickly get started with the installation, development, building, and deployment of RDK_DOC.
I. Environment Installation
To install the dependencies for this project, execute the following command:
npm install
II. Online Operation
To build only the Chinese manual:
npm run start
To build only the English manual:
npm run start -- --locale en
This method does not support switching between Chinese and English documents. It can only build a single language document. If you need to display Chinese and English simultaneously, please refer to the method in Step III.
III. Offline Deployment
To fully deploy the manual offline, please run the following script to download all images locally:
python3 download_imgs.py
For compiling and deploying the documents, use the following command:
npm run build
To deploy the documents, use the following command:
#Direct Deployment
npm run serve
#Deploy with Specified IP Address and Port Number
npm run serve -- --host=10.64.62.34 --port=1688 --no-open
This will start a static file server and provide the following links for access in the browser,The port number should be based on the actual port number:
English manual link: http://localhost:3000/en/rdk_doc/
Chinese manual link: http://localhost:3000/rdk_doc/
Note: Please ensure that Node.js version 18.0 or higher is required.