Skip to content

Commit 3cd55ec

Browse files
committed
调整编写指南,优化说明
1 parent bda1987 commit 3cd55ec

2 files changed

Lines changed: 39 additions & 21 deletions

File tree

rustedwarfareapicode/api-dev.md

Lines changed: 33 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,9 @@ Netlify会在你的PR请求下面显示你的预览页面地址。<br>
7373
由于某些原因,TX会拦截Netlify的站点,请使用浏览器预览。
7474
:::
7575

76+
#### 1.MD扩展格式:
7677

77-
#### 实际格式演示:
78-
::: tip
79-
注意文本
80-
:::
78+
```
8179
8280
::: info
8381
信息文本
@@ -99,11 +97,21 @@ Netlify会在你的PR请求下面显示你的预览页面地址。<br>
9997
这是一个折叠框
10098
:::
10199
100+
#### 代码突出显示
101+
::: code-group
102+
```ini{2} [演示例子]
103+
[action_copyArry]
104+
RTS-APICODE
102105
103-
#### MD扩展格式:
104-
106+
可以通过1-4来让1到4行突出显示,
107+
也可以通过1,4,5来指定行数突出显示
105108
```
106109

110+
#### 实际格式演示:
111+
::: tip
112+
注意文本
113+
:::
114+
107115
::: info
108116
信息文本
109117
:::
@@ -124,22 +132,28 @@ Netlify会在你的PR请求下面显示你的预览页面地址。<br>
124132
这是一个折叠框
125133
:::
126134

127-
#### 单位代码文档推荐格式:
128-
```markdown
129-
### xxxx
130-
#### xxxx-代码简介
131135

132-
#### 视频/GIF演示---(可选)
136+
```ini{2} [演示例子]
137+
[action_copyArry]
138+
RTS-APICODE
139+
//代码突出演示
140+
可以通过1-4来让1到4行突出显示,
141+
也可以通过1,4,5来指定行数突出显示
133142
134-
#### xxxx代码-演示例子
143+
```
144+
145+
### 2.媒体插入
135146

136-
***ini
137-
xxxx
138-
***
147+
#### 1.视频演示---(可选)
148+
<iframe src="https://vdse.bdstatic.com//192d9a98d782d9c74c96f09db9378d93.mp4" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true" width="100%" height="400">
149+
</iframe>
139150

151+
```html
152+
<iframe src="视频地址" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true" width="100%" height="400">
153+
</iframe>
140154
```
141155

142-
#### 表格推荐格式
156+
#### 3.插入表格
143157

144158
### 代码演示:
145159
|A|B|C|
@@ -157,7 +171,7 @@ xxxx
157171
如果你仍然不会Markdown表格写法,这里给你一个链接:
158172
<h3><a href="https://tableconvert.com/zh-cn/markdown-to-markdown" target="_blank">TableConvert-MD-点击进入</a></h3>
159173

160-
### 扩展写法(高级)
174+
### 4.扩展写法(高级)
161175

162176
有一些时候,我们可能需要在已经标记的后面再添加东西,
163177
但Markdown解析方式在标签后面再有一个标签就不会识别了。
@@ -171,6 +185,6 @@ xxxx
171185
该文档可能还有很多缺陷,如果你有更好的建议,请发送Issues或者PR给我。
172186
:::
173187

174-
::: tip
175-
编写于2023-5-9 RTS-Code-API[第3版-第2次修订]
188+
::: info
189+
编写于2023-5-9 RTS-Code-API[第3版-第3次修订]
176190
:::

rustedwarfareapicode/src/Unit/loginboolean.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,9 @@ self.hasResources(hp=10,energy=5)
269269
#### self.isResourceLargerThan()
270270
代码:self.isResourceLargerThan() 中文释义:资源是否大于 返回类型:boolean<br>
271271

272-
> [!ATTENTION] 此代码为老旧解决方案,不推荐使用。
272+
::: warning
273+
此代码为老旧解决方案,不推荐使用。
274+
:::
273275

274276
`self.isResourceLargerThan()`用于比较两种资源的大小。格式为`self.isResourceLargerThan(source=资源A,compareTarget=资源B,byMoreThan=大于资源B数量,multiplyTargetBy=资源B倍数)`
275277

@@ -327,8 +329,10 @@ showMessageToPlayers:10秒过去了
327329

328330
`self.hasFlag()`用于获取自身是否有<font color=orange>标志</font>,格式为`self.hasFlag(id=数字)`
329331

330-
> [!NOTE] 不同于<font color=orange>标签(tag)</font>,<font color=orange>标志(flag)</font>是内置的一些<font color=orange>布尔值</font>,无需定义即可直接使用。<br>
332+
::: info
333+
不同于<font color=orange>标签(tag)</font>,<font color=orange>标志(flag)</font>是内置的一些<font color=orange>布尔值</font>,无需定义即可直接使用。<br>
331334
> 标签的添加方法为<font color=orange>[action]addResource:flag=1,3-7,13</font>,且只支持<font color=orange>0-31</font>,标签的移除方法与之相反。
335+
:::
332336

333337
#### self.tags()
334338
代码:self.tags() 中文释义:有标签 返回类型:boolean<br>

0 commit comments

Comments
 (0)