mirror/yapi
2
0
Fork 0
mirror of https://github.com/YMFE/yapi.git synced 2024-12-15 05:10:47 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: 添加数据导入文档

Browse Source
This commit is contained in:
suxiaoxin 2017-09-15 21:02:45 +08:00
parent 7ec2251585
commit 4741f87bc5
14 changed files with 118 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/page/usage/qa.md
View File

@ -2,10 +2,10 @@
如果没有找到您要的答案，请 qtalk 联系: `wenbo.dong; wenxiong.su; wenjie.zhang.`
## Q: 怎样联系组长？
## Q1: 怎样联系组长？
A: 组长分为 `分组组长` 和 `项目组长`:
- 分组组长：选择首页左侧的分组，点击右侧面板的 `成员列表`，成员右侧显示着 `组长/开发者` 的权限信息。
<img src="./images/usage/manage_find_manager.png" />
- 项目组长: 点击项目页的 `设置` - `成员列表`，成员右侧显示着 `组长/开发者` 的权限信息。
<img src="./images/usage/manage_find_project_owner.png" />
<img src="./images/usage/manage_find_project_owner.png" />

6
static/doc/index-使用mock功能.html
View File

@ -132,6 +132,12 @@
<a href="index-使用测试集.html">使用测试集</a>
</li>
<!-- <li > -->
<li >
<a href="index-数据导入(重要).html">数据导入(重要)</a>
</li>
<!-- <li > -->
<li >

6
static/doc/index-使用测试集.html
View File

@ -128,6 +128,12 @@
</ul>
<!-- <li > -->
<li >
<a href="index-数据导入(重要).html">数据导入(重要)</a>
</li>
<!-- <li > -->
<li >

6
static/doc/index-创建第一个API.html
View File

@ -124,6 +124,12 @@
<a href="index-使用测试集.html">使用测试集</a>
</li>
<!-- <li > -->
<li >
<a href="index-数据导入(重要).html">数据导入(重要)</a>
</li>
<!-- <li > -->
<li >

10
static/doc/index-常见问题.html
View File

@ -108,6 +108,12 @@
<a href="index-使用测试集.html">使用测试集</a>
</li>
<!-- <li > -->
<li >
<a href="index-数据导入(重要).html">数据导入(重要)</a>
</li>
<!-- <li class="active" class="active" > -->
<li class="active" >
@ -117,7 +123,7 @@
<ul class="nav docs-sidenav-extend" >
<li >
<a href="#Q__怎样联系组长？">Q: 怎样联系组长？</a>
<a href="#Q1__怎样联系组长？">Q1: 怎样联系组长？</a>
</li>
</ul>
@ -130,7 +136,7 @@
<p>本页面罗列了大家使用 YApi 时遇到的常见问题.</p>
<p>如果没有找到您要的答案，请 qtalk 联系: <code>wenbo.dong; wenxiong.su; wenjie.zhang.</code></p>
<h2 class="subject" id="Q__怎样联系组长？">Q: 怎样联系组长？ <a class="hashlink" href="#Q__怎样联系组长？">#</a></h2><p>A: 组长分为 <code>分组组长</code> 和 <code>项目组长</code>:</p>
<h2 class="subject" id="Q1__怎样联系组长？">Q1: 怎样联系组长？ <a class="hashlink" href="#Q1__怎样联系组长？">#</a></h2><p>A: 组长分为 <code>分组组长</code> 和 <code>项目组长</code>:</p>
<ul>
<li>分组组长：选择首页左侧的分组，点击右侧面板的 <code>成员列表</code>，成员右侧显示着 <code>组长/开发者</code> 的权限信息。
<img src="./images/usage/manage_find_manager.png" /></li><li>项目组长: 点击项目页的 <code>设置</code> - <code>成员列表</code>，成员右侧显示着 <code>组长/开发者</code> 的权限信息。

6
static/doc/index-接口操作.html
View File

@ -120,6 +120,12 @@
<a href="index-使用测试集.html">使用测试集</a>
</li>
<!-- <li > -->
<li >
<a href="index-数据导入(重要).html">数据导入(重要)</a>
</li>
<!-- <li > -->
<li >

6
static/doc/index-管理分组与项目.html
View File

@ -128,6 +128,12 @@
<a href="index-使用测试集.html">使用测试集</a>
</li>
<!-- <li > -->
<li >
<a href="index-数据导入(重要).html">数据导入(重要)</a>
</li>
<!-- <li > -->
<li >

6
static/doc/index-认识 YApi.html
View File

@ -128,6 +128,12 @@
<a href="index-使用测试集.html">使用测试集</a>
</li>
<!-- <li > -->
<li >
<a href="index-数据导入(重要).html">数据导入(重要)</a>
</li>
<!-- <li > -->
<li >

6
static/doc/index-项目操作.html
View File

@ -124,6 +124,12 @@
<a href="index-使用测试集.html">使用测试集</a>
</li>
<!-- <li > -->
<li >
<a href="index-数据导入(重要).html">数据导入(重要)</a>
</li>
<!-- <li > -->
<li >

6
static/doc/index.html
View File

@ -108,6 +108,12 @@
<a href="index-使用测试集.html">使用测试集</a>
</li>
<!-- <li > -->
<li >
<a href="index-数据导入(重要).html">数据导入(重要)</a>
</li>
<!-- <li > -->
<li >

107
static/doc/source/app.js
View File

@ -1,3 +1,6 @@
var EXAMPLE_MAX_HEIGHT = 98,
DEFAULT_SHOW_PARAMS = 5;
$(document).ready(function() {
// 移动端导航
var $openPanel = $('.open-panel');
@ -8,6 +11,7 @@ $(document).ready(function() {
var $versionSelector = $('.version-selector');
var $versionMask = $('.m-version-mask');
var isPanelHide = true;
var winWidth = $(window).width();
var h2 = $('.content-right').find('h2');
var h3 = $('.content-right').find('h3');
var a = $('.content-left').find('a');
@ -121,6 +125,7 @@ $(document).ready(function() {
})
$versionSelector.click(function(e) {
$versionMask.show();
console.log('e');
});
$('.markdown-body pre').map(function(i, item) {
@ -128,61 +133,59 @@ $(document).ready(function() {
$(item).children('code').addClass('js-code-'+i);
});
// var winHeight = $(window).height() - 44,
// sidebar = $('.docs-sidebar');
var winHeight = $(window).height() - 44,
sidebar = $('.docs-sidebar');
var docSideNav = $('.docs-sidenav');
if (winWidth > 767) {
docSideNav.width($contentLeftWidth);
}
if (sidebar.height() > winHeight) {
sidebar.css('max-height', winHeight + 'px');
$('.docs-sidenav').css('max-height', winHeight + 'px');
if (winWidth < 768) {
$('.docs-sidenav').css({
'overflow-x': 'hidden'
});
}
var activeMenu,
barScroll = false;
// var docSideNav = $('.docs-sidenav');
// if (winWidth > 767) {
// docSideNav.width($contentLeftWidth);
// }
sidebar.on('mouseover', function() {
barScroll = true;
});
sidebar.on('mouseout', function() {
barScroll = false;
});
};
// if (sidebar.height() > winHeight) {
// sidebar.css('max-height', winHeight + 'px');
// $('.docs-sidenav').css('max-height', winHeight + 'px');
// if (winWidth < 768) {
// $('.docs-sidenav').css({
// 'overflow-x': 'hidden'
// });
// }
// var activeMenu,
// barScroll = false;
//
// sidebar.on('mouseover', function() {
// barScroll = true;
// });
// sidebar.on('mouseout', function() {
// barScroll = false;
// });
// };
$(window).on('scroll', function(e) {
if ($(this).scrollTop() > ($('.footer').offset().top - $(window).height())) {
winHeight = $(window).height() - $('.footer').outerHeight() - 44;
sidebar.css('max-height', winHeight + 'px');
$('.docs-sidenav').css('max-height', winHeight + 'px');
} else {
winHeight = $(window).height() - 44;
sidebar.css('max-height', winHeight + 'px');
$('.docs-sidenav').css('max-height', winHeight + 'px');
}
// $(window).on('scroll', function(e) {
// if ($(this).scrollTop() > ($('.footer').offset().top - $(window).height())) {
// winHeight = $(window).height() - $('.footer').outerHeight() - 44;
// sidebar.css('max-height', winHeight + 'px');
// $('.docs-sidenav').css('max-height', winHeight + 'px');
// } else {
// winHeight = $(window).height() - 44;
// sidebar.css('max-height', winHeight + 'px');
// $('.docs-sidenav').css('max-height', winHeight + 'px');
// }
//
// if (!barScroll) {
// var activeItem = $('.docs-sidebar li.active a');
// if (activeItem.length) {
// if (!activeMenu || (activeMenu.attr('href') != activeItem.attr('href'))) {
// activeMenu = activeItem;
// var top = activeMenu.offset().top - sidebar.offset().top;
// if (top < 0) {
// //sidebar.scrollTop(sidebar.scrollTop() + top);
// $('.docs-sidenav').scrollTop($('.docs-sidenav').scrollTop() + top);
// } else if (top > winHeight - 88) {
// //sidebar.scrollTop(sidebar.scrollTop() + top - winHeight + 44);
// $('.docs-sidenav').scrollTop($('.docs-sidenav').scrollTop() + top - winHeight + 88);
// }
// }
// }
// }
// });
if (!barScroll) {
var activeItem = $('.docs-sidebar li.active a');
if (activeItem.length) {
if (!activeMenu || (activeMenu.attr('href') != activeItem.attr('href'))) {
activeMenu = activeItem;
var top = activeMenu.offset().top - sidebar.offset().top;
if (top < 0) {
//sidebar.scrollTop(sidebar.scrollTop() + top);
$('.docs-sidenav').scrollTop($('.docs-sidenav').scrollTop() + top);
} else if (top > winHeight - 88) {
//sidebar.scrollTop(sidebar.scrollTop() + top - winHeight + 44);
$('.docs-sidenav').scrollTop($('.docs-sidenav').scrollTop() + top - winHeight + 88);
}
}
}
}
});
// 退出全屏浏览器窗口大小改变，不触发resize
$(window).on('resize', function(e) {

2
static/doc/source/code.css
View File

File diff suppressed because one or more lines are too long

2
static/doc/source/main.css
View File

File diff suppressed because one or more lines are too long

3
ydoc.json
View File

@ -49,6 +49,9 @@
},{
"name": "使用测试集",
"content": "./doc/page/usage/case.md"
},{
"name": "数据导入(重要)",
"content": "./doc/page/usage/data.md"
},{
"name": "常见问题",
"content": "./doc/page/usage/qa.md"