添加对文档编撰的说明
This commit is contained in:
parent
e23b6000c4
commit
5555e612b3
44
README.md
44
README.md
@ -1,12 +1,32 @@
|
|||||||
# 节奏医生中文编辑器教程网站
|
# 节奏医生中文编辑器教程网站
|
||||||
|
|
||||||
## 预览和编辑
|
## 预览
|
||||||
|
|
||||||
### [Visual Studio Code](https://code.visualstudio.com/)
|
### [Visual Studio Code](https://code.visualstudio.com/)
|
||||||
|
|
||||||
此项目基于 [docsify](https://docsify.js.org/#/) 编辑,并使用 [RDView](https://github.com/OLDRedstone/RDView) 显示编辑器可交互模块。
|
此项目基于 [docsify](https://docsify.js.org/#/) 编辑,并使用 [RDView](https://github.com/OLDRedstone/RDView) 和 [RhythmBase.View(RDTKView)](https://github.com/OLDRedstone/RhythmBase.View) 显示编辑器可交互模块。
|
||||||
|
可以参考以下多种方案预览编辑效果。
|
||||||
|
|
||||||
- 确保 [安装 markdown-rdview-support](https://github.com/OLDRedstone/markdown-rdview-support) 即可预览 RDView 内容。
|
- [安装 docsify](https://docsify.js.org/#/quickstart) 以实时预览页面。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm i docsify-cli -g
|
||||||
|
```
|
||||||
|
|
||||||
|
- 运行以下命令以启动本地服务器实时预览。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docsify s
|
||||||
|
```
|
||||||
|
|
||||||
|
- 在 Visual Studio Code 插件商店[安装 Live Server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer) 以预览。
|
||||||
|
|
||||||
|
### RDView
|
||||||
|
|
||||||
|
> ### 此条目即将废弃。
|
||||||
|
> 请优先使用 RhythmBase.View 格式。
|
||||||
|
|
||||||
|
- [安装 markdown-rdview-support](https://github.com/OLDRedstone/markdown-rdview-support) 以预览 RDView 内容。
|
||||||
如果成功安装,那么以下内容的 markdown 预览应当是一个事件栏。
|
如果成功安装,那么以下内容的 markdown 预览应当是一个事件栏。
|
||||||
|
|
||||||
```rdview 7 5 1
|
```rdview 7 5 1
|
||||||
@ -15,16 +35,18 @@ es.SetCrotchetsPerBar_4 0 1[];
|
|||||||
eb.AddClassicBeat 0 2[tick=6];
|
eb.AddClassicBeat 0 2[tick=6];
|
||||||
```
|
```
|
||||||
|
|
||||||
- 确保 [安装 docsify](https://docsify.js.org/#/quickstart) 以实时预览页面。
|
### RhythmBase.View
|
||||||
|
|
||||||
```bash
|
RDView 的替代。
|
||||||
npm i docsify-cli -g
|
可以直接使用关卡文件内格式进行展示。
|
||||||
```
|
暂无计划支持 Visual Studio Code 内预览。(~~感觉没必要支持~~)
|
||||||
|
可以访问[此处](https://view.obugs.cn/)以预览效果和获得额外属性说明。
|
||||||
|
|
||||||
- 运行以下命令以启动本地服务器实时预览。
|
## 编辑
|
||||||
|
|
||||||
```bash
|
请尽量使用 [RhythmBase.View(RDTKView)](https://github.com/OLDRedstone/RhythmBase.View) 格式展示事件。
|
||||||
docsify s
|
本教程后期将会逐步迁移模块指此格式。
|
||||||
```
|
|
||||||
|
## 其他
|
||||||
|
|
||||||
Game assets courtesy of [7th Beat Games](https://7thbe.at/). Game assets are excluded from this site's license.
|
Game assets courtesy of [7th Beat Games](https://7thbe.at/). Game assets are excluded from this site's license.
|
||||||
Loading…
x
Reference in New Issue
Block a user