wuleewang / rdk_doc Goto Github PK

English| 简体中文

Welcome to this project! This document will help you quickly get started with the installation, development, building, and deployment of RDK_DOC.

To install the dependencies for this project, execute the following command:

$ npm install

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.

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