Home

Awesome

Rainbond Document

Rainbond Document, Contains all documents for Rainbond 5.x.

This website uses Docusaurus 2 framework.

How to develop?

Prepare

Development Environment Requirements:

Install

if yarn install Very slow,You can try configuring the Domestic Registry.

$ yarn config set registry https://registry.npmmirror.com

initialization

$ git clone https://github.com/goodrain/rainbond-docs.git
$ cd rainbond-docs
$ yarn install

Local Start

$ yarn start

will automatically open in the browser http://localhost:3000/

Local production test starts

Use the following command to simulate a production test launch locally

$ yarn serve --build .

Contribution

Older versions of documentation are no longer maintained, Only the Current version is maintained.

Fork Rainbond-docs, Modify the document and submit it to your own repository, submit Pull Request to Rainbond-docs

Typesetting requirements

Add Markdown file

If you need to add files, Add to the corresponding directory in the docs/ directory, And fill in the new file names in order in sidebars.js, Ref Docusaurus Sidebar

Translation

Chinese translation to English, in the i18n/en/docusaurus-plugin-content-docs/current directory, Create files consistent with the ones in the docs directory.

For example: translate docs/quick-install/quick-install.mdx ,in the i18n/en/docusaurus-plugin-content-docs/current Create the same file in the same directory i18n/en/docusaurus-plugin-content-docs/current/quick-install/quick-install.mdx

Local Multilingual Start

$ yarn start -- --locale en 

The default is Chinese. After starting the English version, it will be automatically opened in the browser http://localhost:3000/en