Документация Rainbond

Документация Rainbond, содержащая все документы для версий Rainbond 5.x.

Этот веб-сайт использует фреймворк Docusaurus 2.

Как разрабатывать?

Подготовка

Требования к среде разработки:

• Git
• Node.js >= 14 (с NPM)
• Yarn >= 1.5

Установка

Если установка с помощью Yarn очень медленна, вы можете попробовать настроить внутренний реестр.

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

Инициализация

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

Запуск локально

$ yarn start

будет автоматически открыто в браузере http://localhost:3000/.

Локальный запуск для тестирования в режиме производства

Используйте следующую команду для локального запуска, имитирующего тестирование в режиме производства

$ yarn serve --build .

Вклад

Старые версии документации больше не поддерживаются, поддерживается только текущая версия.

Создайте форк Rainbond-docs, измените документацию и отправьте её в свой собственный репозиторий, затем создайте запрос на слияние Pull Request в Rainbond-docs.

Требования к наброскам* Обязательно должны присутствовать пробелы для разделения китайских и английских слов.

• Rainbond, буква R должна быть заглавной.

• Номер заголовков лучше всего использовать 1, 2, 3, 4.

• Название заголовка должно быть понятным на первый взгляд.

• Формат импорта изображений следующий

  ![API](https://grstatic.oss-cn-shanghai.aliyuncs.com/images/5.1/images/api.png)
  <!-- Также можно использовать -->
  <img src="https://grstatic.oss-cn-shanghai.aliyuncs.com/images/5.1/images/api.png" width="100%" title="API" />

• Формат цитирования ссылок следующий

  1. Ссылки внутри документа, Ref docusaurus doc
  2. Ссылки на внешние источники должны содержать http или https

  [Rainbond](https://www.rainbond.com)
  
  <!-- Также можно использовать -->
  <a href="https://www.rainbond.com" target="_blank" />
  ```* Формат видео следующий:
  
  ```html
  import Bvideo from "@site/src/components/Bvideo";
  <Bvideo src="//player.bilibili.com/player.html?aid=550933549&bvid=BV1Vq4y1w7FQ&cid=492223110&page=1"/>

• Пример использования блока кода Docusaurus Code block

• Уведомление пользователя используйте Docusaurus notice

Добавление файла Markdown

Если вам нужно добавить файлы, добавьте их в соответствующую директорию в директории docs/. Заполните новые названия файлов последовательно в sidebars.js. Подробнее см. Docusaurus Sidebar.

Перевод

Перевод с китайского на английский создайте файлы в директории i18n/en/docusaurus-plugin-content-docs/current, соответствующие файлам в директории docs.

Например: переведите docs/quick-install/quick-install.mdx, создайте такой же файл в директории i18n/en/docusaurus-plugin-content-docs/current/quick-install/quick-install.mdx.

Локализация мультиязычной версии запуска

$ yarn start -- --locale en 

По умолчанию используется китайский язык. После запуска английской версии она автоматически откроется в браузере по адресу http://localhost:3bk00/en