Rainbond 文档,包含 Rainbond 5.x 所有文档
本网站使用了 Hugo框架 Docusaurus 2 文档框架。
确保您的开发环境有如下软件:
如果yarn install的速度很慢,可以尝试配置淘宝Registry。
$ yarn config set registry https://registry.npm.taobao.org
安装初始化
$ git clone https://github.com/goodrain/rainbond-docs.git
$ cd rainbond-docs
$ yarn install
$ yarn start
将在浏览器中自动打开http://localhost:3000/
使用以下命令在本地模拟生产测试启动
$ yarn serve --build .
旧版本文档不再维护,只维护 Current 版。
将 Rainbond-docs 仓库 Fork 到自己的仓库,修改文档并提交至自己的仓库,提交 Pull Request 到 Rainbond-docs
Rainbond 中文档分为 概念性文档 操作指引性文档 和 最佳实践性文档 不同的文档类型。编写文档请明确文档的类型,根据不同的类型需要达成的效果进行文章内容的确定。
中英文夹杂要有空格区分,也可使用反引号包裹起来 ``
例如:我在 Rainbond 上部署xxx,我在 Rainbond
上部署xxx
文档中出现 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架构" />
链接的引用格式如下
[Rainbond](https://www.rainbond.com)
<!-- 也可以使用 -->
<a href="https://www.rainbond.com" target="_blank" />
引入视频格式如下
import Bvideo from "@site/src/components/Bvideo";
<Bvideo src="//player.bilibili.com/player.html?aid=550933549&bvid=BV1Vq4y1w7FQ&cid=492223110&page=1"/>
代码块的使用参考 Docusaurus 代码块
文档中如有 "用户须知" 要使用 Docusaurus 告示
如果需要新增文件,在 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
下创建相同目录的相同文件 ``i18n/en/docusaurus-plugin-content-docs/current/quick-install/quick-install.mdx`
$ yarn start -- --locale en
默认为中文,启动英文版本后,在浏览器中自动打开http://localhost:3000/en/
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。
1. 开源生态
2. 协作、人、软件
3. 评估模型