docs: 更新文档

This commit is contained in:
wenbo.dong 2017-09-06 17:41:16 +08:00
parent 40d8267bbc
commit 65e9920377
12 changed files with 52 additions and 1 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 144 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

View File

@ -1,3 +1,39 @@
## 新建项目
点击右上角的 `+` 新建项目,进入新建项目页面。
<img src="./images/usage/project_add.png" />
在新建项目页,填写项目信息:
> - 项目名称不允许重复,包括其他分组
> - 基本路径为接口统一添加了前缀
> - 新建项目页只列出了部分配置,其他详细配置(环境配置、项目图标等)需要进入项目页的“设置”面板进行配置。
<img src="./images/usage/project_add_panel.png" />
## 修改项目
在项目页点击上方的 `设置` Tab 进入项目设置面板,这个面板涵盖了项目的所有配置。
<img src="./images/usage/project_setting.png" />
这里比新建项目页面新增的功能如下:
### 修改项目图标
点击项目图标,可以修改图标及背景色:
<img src="./images/usage/project_setting_logo.png" />
### 配置环境
点击项目图标,可以修改图标及背景色:
<img src="./images/usage/project_setting_logo.png" />
## 删除项目
点击下方的删除按钮,输入项目名称进行删除。
> 删除项目是高风险操作,因此 YApi 对这个操作进行了特别的约束。

Binary file not shown.

Before

Width:  |  Height:  |  Size: 144 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

View File

@ -136,7 +136,22 @@
<div class="content-right markdown-body use-sidebar" role="main">
<h2 class="subject" id="新建项目">新建项目 <a class="hashlink" href="#新建项目">#</a></h2><h2 class="subject" id="修改项目">修改项目 <a class="hashlink" href="#修改项目">#</a></h2>
<h2 class="subject" id="新建项目">新建项目 <a class="hashlink" href="#新建项目">#</a></h2><p>点击右上角的 <code>+</code> 新建项目,进入新建项目页面。</p>
<p><img src="./images/usage/project_add.png" /></p>
<p>在新建项目页,填写项目信息:</p>
<blockquote>
<ul>
<li>项目名称不允许重复,包括其他分组</li><li>基本路径为接口统一添加了前缀</li><li>新建项目页只列出了部分配置,其他详细配置(环境配置、项目图标等)需要进入项目页的“设置”面板进行配置。</li></ul>
</blockquote>
<p><img src="./images/usage/project_add_panel.png" /></p>
<h2 class="subject" id="修改项目">修改项目 <a class="hashlink" href="#修改项目">#</a></h2><p>在项目页点击上方的 <code>设置</code> Tab 进入项目设置面板,这个面板涵盖了项目的所有配置。</p>
<p><img src="./images/usage/project_setting.png" /></p>
<p>这里比新建项目页面新增的功能如下:</p>
<h3 class="subject" id="修改项目图标">修改项目图标 <a class="hashlink" href="#修改项目图标">#</a></h3><p>点击项目图标,可以修改图标及背景色:</p>
<p><img src="./images/usage/project_setting_logo.png" /></p>
<h3 class="subject" id="配置环境">配置环境 <a class="hashlink" href="#配置环境">#</a></h3><p>点击项目图标,可以修改图标及背景色:</p>
<p><img src="./images/usage/project_setting_logo.png" /></p>
</div>
</div>