Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/goodrain/rainbond-docs
Rainbond user documentation
https://github.com/goodrain/rainbond-docs
rainbond rainbond-documentation rainbond-environment
Last synced: 5 days ago
JSON representation
Rainbond user documentation
- Host: GitHub
- URL: https://github.com/goodrain/rainbond-docs
- Owner: goodrain
- Created: 2017-11-09T01:44:54.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-12-18T07:48:36.000Z (16 days ago)
- Last Synced: 2024-12-22T18:11:46.297Z (12 days ago)
- Topics: rainbond, rainbond-documentation, rainbond-environment
- Language: TypeScript
- Homepage: https://www.rainbond.com/docs
- Size: 203 MB
- Stars: 41
- Watchers: 12
- Forks: 101
- Open Issues: 8
-
Metadata Files:
- Readme: README-zh.md
Awesome Lists containing this project
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
```
* 链接的引用格式如下
1. 引用文档内其他文档要使用相对路径，参考 [docusaurus文档](https://docusaurus.io/zh-CN/docs/markdown-features/assets)
2. 引用外部链接必须要带 http or https
```html
[Rainbond](https://www.rainbond.com)
```
* 引入视频格式如下
```html
import Bvideo from "@site/src/components/Bvideo";
```
* 代码块的使用参考 [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/