Skip to content

Commit

Permalink
docs: Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lkqm committed Sep 23, 2021
1 parent 7d40b7d commit a6b24c2
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 1 deletion.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
- [x] 上传到YApi平台
- [x] 上传到Rap2平台
- [x] 上传到Eolinker平台
- [x] 上传到ShowDoc平台
- [x] 导出markdown文件
- [x] 复制为cURL命令

<img src="doc/screenshots.gif" height="360">
Expand Down
2 changes: 2 additions & 0 deletions doc/GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ TODO
#### Eolinker
目前支持eolinker5.0版本,仅测试了官方提供的sass版本: https://riag.w.eolinker.com

#### ShowDoc

## 配置文件
大多数情况下您只需要配置关联的项目标识(xxxProjectId)即可,更多配置项可满足你的99%的场景。
Expand All @@ -46,6 +47,7 @@ TODO
| yapiProjectId | integer | YApi项目id |
| rap2ProjectId | integer | Rap2项目id |
| eolinkerProjectId | string | Eolinker项目id |
| showdocProjectId | string | ShowDoc项目id |
| yapiUrl | string | YApi服务地址 | 场景:插件无法支持YApi统一登录方式,此时可使用项目token方式 |
| yapiProjectToken | string | YApi项目访问token |
| | | |
Expand Down
4 changes: 3 additions & 1 deletion src/main/resources/META-INF/plugin.xml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<idea-plugin>
<id>yapix</id>
<name>Yapi X</name>
<version>0.6.2021091801</version>
<version>0.7</version>
<vendor url="https://github.com/jetplugins">Jetplugins</vendor>

<description><![CDATA[
Expand All @@ -17,6 +17,8 @@
<li>Upload to YApi platform.</li>
<li>Upload to Rap2 platform.</li>
<li>Upload to Eolinker platform.</li>
<li>Upload to ShowDoc platform.</li>
<li>Export to markdown.</li>
<li>Copy as cURL.</li>
</ul>
<img src="https://raw.githubusercontent.com/jetplugins/yapix/main/doc/screenshots.gif" height="360">
Expand Down

0 comments on commit a6b24c2

Please sign in to comment.