rainbond-docs: Rainbond Docs

代码拉取完成,页面将自动刷新

开源项目 > 其他开源 > 图书/手册/教程 &&

扫描微信二维码支付

取消

支付完成

richgiteeai

Watch

不关注关注所有动态仅关注版本发行动态关注但不提醒动态

2 Star 8 Fork 9

Rainbond/rainbond-docs

代码 Issues 0 Pull Requests 0 Wiki 统计流水线

服务

加入 Gitee

与超过 1400万开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)

免费加入

已有帐号? 立即登录

该仓库未声明开源许可证文件(LICENSE),使用请关注具体项目描述及其代码上游依赖。

项目仓库所选许可证以仓库主分支所使用许可证为准

克隆/下载

HTTPS SSH SVN SVN+SSH 下载ZIP

提示

下载代码请复制以下命令到终端执行

为确保你提交的代码身份被 Gitee 正确识别,请执行以下命令完成配置

git config --global user.name userName 
git config --global user.email userEmail

初次使用 SSH 协议进行代码克隆、推送等操作时,需按下述提示完成 SSH 配置

1 生成 RSA 密钥

2 获取 RSA 公钥内容,并配置到 SSH公钥中

在 Gitee 上使用 SVN,请访问使用指南

使用 HTTPS 协议时,命令行会出现如下账号密码验证步骤。基于安全考虑,Gitee 建议配置并使用私人令牌替代登录密码进行克隆、推送等操作

Username for 'https://gitee.com': userName

Password for 'https://userName@gitee.com': # 私人令牌

新建文件新建 Diagram 文件

新建子模块

上传文件

分支 43

标签 8

贡献代码

同步代码

创建 Pull Request

了解更多

对比差异通过 Pull Request 同步

同步更新到分支

通过 Pull Request 同步

将会在向当前分支创建一个 Pull
Request,合入后将完成同步

shun634501730 docs: add missing injected environment var... 5421fe9

3391 次提交

.github/workflows

blog

community

docs

i18n/en

src

static

.gitignore

Dockerfile

README-zh.md

README.md

babel.config.js

crowdin.yml

docusaurus.config.js

nginx.conf

package.json

release.sh

sidebars.js

sidebarsCommunity.js

tsconfig.json

versions.json

versionsArchived.json

yarn.lock

README

# Rainbond 文档

Rainbond 文档,包含 Rainbond 5.x 所有文档

本网站使用了 ~~Hugo框架~~ [Docusaurus 2](https://docusaurus.io/) 文档框架。

## 如何开发?

### 准备

确保您的开发环境有如下软件:

- [Git](http://git-scm.com/)
- [Node.js](http://nodejs.org/) \>= 14 (with NPM)
- [Yarn](https://yarnpkg.com/en/docs/install) \>= 1.5

### 安装

如果yarn install的速度很慢,可以尝试配置淘宝Registry。

```
$ yarn config set registry https://registry.npm.taobao.org
```

安装初始化

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

### 本地启动

```bash
$ yarn start
```

将在浏览器中自动打开http://localhost:3000/

### 本地生产测试启动

使用以下命令在本地模拟生产测试启动

```bash
$ yarn serve --build .
```

## 参与贡献

旧版本文档不再维护,只维护 Current 版。

将 [Rainbond-docs](https://github.com/goodrain/rainbond-docs.git) 仓库 Fork 到自己的仓库,修改文档并提交至自己的仓库,提交 Pull Request 到 [Rainbond-docs](https://github.com/goodrain/rainbond-docs.git)

### 内容要求

Rainbond 中文档分为 **概念性文档** **操作指引性文档** 和 **最佳实践性文档** 不同的文档类型。编写文档请明确文档的类型,根据不同的类型需要达成的效果进行文章内容的确定。

### 排版要求

* 中英文夹杂要有空格区分,也可使用反引号包裹起来 ``

例如:我在 Rainbond 上部署xxx,我在 `Rainbond` 上部署xxx

* 文档中出现 Rainbond 字样,R 必须是大写。

* 标题最好是 1 2 3 4 级,五六级标题尽量避免,如果内容太多确实需要可以加上。

* 标题的命名要一目了然

* 引入图片格式如下

```html
 ![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. 引用文档内其他文档要使用相对路径,参考 [docusaurus文档](https://docusaurus.io/zh-CN/docs/markdown-features/assets)
 2. 引用外部链接必须要带 http or https

```html
 [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 代码块](https://docusaurus.io/zh-CN/docs/markdown-features/code-blocks)

* 文档中如有 "用户须知" 要使用 [Docusaurus 告示](https://docusaurus.io/zh-CN/docs/markdown-features/admonitions)

#### 新增MD文件

如果需要新增文件,在 `docs/` 目录下增加至对应的目录内,并在 `sidebars.js` 中按照顺序填写新增的文件名,可参考 [Docusaurus Sidebar](https://docusaurus.io/zh-CN/docs/sidebar)。

### 文档翻译

文档中文翻译英文,在 `i18n/en/docusaurus-plugin-content-docs/current` 目录下,创建与 `docs` 目录下的一致的文件。

例如:翻译 `docs/quick-install/quick-install.mdx` ,在 `i18n/en/docusaurus-plugin-content-docs/current` 下创建相同目录的相同文件 ``i18n/en/docusaurus-plugin-content-docs/current/quick-install/quick-install.mdx`

#### 本地多语言启动

```bash
$ yarn start -- --locale en 
```

默认为中文,启动英文版本后,在浏览器中自动打开http://localhost:3000/en/