mirror of
https://github.com/YMFE/yapi.git
synced 2025-04-06 15:00:26 +08:00
docs: opti docs
This commit is contained in:
suxiaoxin
parent
5874b190f8
commit
3f937b4404
37
doc/page/plugin/redev.md
Normal file
37
doc/page/plugin/redev.md
Normal file
@ -0,0 +1,37 @@
|
||||
## 运行开发服务器
|
||||
|
||||
首先确保安装了 ykit, 没有安装请执行 npm install -g ykit
|
||||
|
||||
```
|
||||
mkdir yapi
|
||||
cd yapi
|
||||
git clone https://github.com/YMFE/yapi.git vendors
|
||||
cp vendors/config_example.json ./config.json //复制完成后请修改相关配置
|
||||
cd vendors
|
||||
npm install
|
||||
node run install-server //安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
|
||||
npm run dev //启动服务器后，请访问 127.0.0.1:{config.json配置的端口}，初次运行会有个编译的过程，请耐心等候
|
||||
```
|
||||
|
||||
## 安装成功后的目录结构
|
||||
|
||||
```
|
||||
yapi
|
||||
config.json //服务器配置，可参考 vendors/config_example.json
|
||||
vendors //yapi
|
||||
init.lock //安装锁文件，重新安装需要删除此文件
|
||||
log //运行日志
|
||||
```
|
||||
|
||||
## 技术栈说明
|
||||
|
||||
后端： koa mongoose
|
||||
|
||||
前端： react redux
|
||||
|
||||
## 启动 prd 环境服务器
|
||||
```
|
||||
cd vendors
|
||||
ykit pack -m
|
||||
node server/app.js
|
||||
```
|
||||
@ -72,9 +72,14 @@ body, h1, h2, h3, h4, h5, h6 {
|
||||
font-family: 'Dosis', 'Source Sans Pro', 'Helvetica Neue', Arial, sans-serif;
|
||||
}
|
||||
.ydoc .ydoc-banner-bg {
|
||||
background: url(https://ws1.sinaimg.cn/large/006cGJIjly1fl42tf966mj31dr0aqahp.jpg) 0 top repeat-x;
|
||||
background-color: #232323;
|
||||
/* background: url(https://ws1.sinaimg.cn/large/006cGJIjly1fl42tf966mj31dr0aqahp.jpg) 0 top repeat-x; */
|
||||
/* background-color: #232323; */
|
||||
/* background: linear-gradient(45deg,#020031 0,#6d3353 100%); */
|
||||
background: linear-gradient(45deg,#03010e 0,#a75afb 100%);
|
||||
|
||||
}
|
||||
|
||||
|
||||
.ydoc .ydoc-banner-home .home-desc{
|
||||
padding: 0 1rem .16rem;
|
||||
font-weight: normal;
|
||||
@ -128,3 +133,33 @@ body, h1, h2, h3, h4, h5, h6 {
|
||||
transform: rotate(360deg);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
.ydoc .ydoc-banner-home .home-btn{
|
||||
color: #e5e6e6;
|
||||
font-weight: 400;
|
||||
}
|
||||
|
||||
.ydoc .ydoc-banner-home .home-version{
|
||||
/* color: #969594; */
|
||||
color: #cfcdd1;
|
||||
}
|
||||
|
||||
.ydoc-header{
|
||||
background: #fff;
|
||||
}
|
||||
|
||||
.ydoc-header a, .ydoc-nav{
|
||||
color: #333;
|
||||
}
|
||||
|
||||
.ydoc-nav li a {
|
||||
padding: 0 15px;
|
||||
color: #4f2a7c;
|
||||
font-weight: 400;
|
||||
transition: all .4s;
|
||||
}
|
||||
|
||||
.ydoc .home-page-desc{
|
||||
color: #6b6868;
|
||||
}
|
||||
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "yapi",
|
||||
"version": "1.2.3",
|
||||
"version": "1.2.4",
|
||||
"description": "YAPI",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
|
||||
@ -45,7 +45,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="plugin.html">插件Wiki</a>
|
||||
<a href="plugin.html">插件 Wiki</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo站点</a>
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo 站点</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -141,15 +141,15 @@
|
||||
<ul class="nav docs-sidenav-extend" >
|
||||
|
||||
<li >
|
||||
<a href="#Mock 期望">Mock 期望</a>
|
||||
<a href="#Mock_期望">Mock 期望</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#自定义 Mock 脚本">自定义 Mock 脚本</a>
|
||||
<a href="#自定义_Mock_脚本">自定义 Mock 脚本</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#Mock 优先级说明">Mock 优先级说明</a>
|
||||
<a href="#Mock_优先级说明">Mock 优先级说明</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@ -240,7 +240,7 @@ mockJson = <span class="token punctuation">{</span>
|
||||
|
||||
<footer class="footer">
|
||||
<div class="copyright">
|
||||
© 2016 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
© 2017 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
@ -45,7 +45,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="plugin.html">插件Wiki</a>
|
||||
<a href="plugin.html">插件 Wiki</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo站点</a>
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo 站点</a>
|
||||
</li>
|
||||
|
||||
<li class="active">
|
||||
@ -5204,7 +5204,7 @@
|
||||
|
||||
<footer class="footer">
|
||||
<div class="copyright">
|
||||
© 2016 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
© 2017 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
@ -45,7 +45,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="plugin.html">插件Wiki</a>
|
||||
<a href="plugin.html">插件 Wiki</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo站点</a>
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo 站点</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -236,7 +236,7 @@ assert.equal(body.data.group_name<span class="token punctuation">,</span> 'testG
|
||||
|
||||
<footer class="footer">
|
||||
<div class="copyright">
|
||||
© 2016 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
© 2017 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
@ -45,7 +45,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="plugin.html">插件Wiki</a>
|
||||
<a href="plugin.html">插件 Wiki</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo站点</a>
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo 站点</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -157,15 +157,15 @@
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#Postman 数据导入">Postman 数据导入</a>
|
||||
<a href="#Postman_数据导入">Postman 数据导入</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#HAR 数据导入">HAR 数据导入</a>
|
||||
<a href="#HAR_数据导入">HAR 数据导入</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#Swagger 数据导入">Swagger 数据导入</a>
|
||||
<a href="#Swagger_数据导入">Swagger 数据导入</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@ -218,7 +218,7 @@
|
||||
|
||||
<footer class="footer">
|
||||
<div class="copyright">
|
||||
© 2016 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
© 2017 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
@ -45,7 +45,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="plugin.html">插件Wiki</a>
|
||||
<a href="plugin.html">插件 Wiki</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo站点</a>
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo 站点</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -77,6 +77,15 @@
|
||||
|
||||
<!-- Docs page layout -->
|
||||
|
||||
<div class="ydoc-banner-bg">
|
||||
<div class="ydoc-banner ">
|
||||
<div class="ydoc-banner-area">
|
||||
<h1 >内网部署</h1>
|
||||
<p class="desc ">部署 YApi 平台是非常容易的，即便您不懂 nodejs 或者 mongodb</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="ydoc-container">
|
||||
|
||||
@ -108,7 +117,7 @@
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="#配置邮箱 (仅支持 SMTP)">配置邮箱 (仅支持 SMTP)</a>
|
||||
<a href="#配置邮箱__仅支持_SMTP_">配置邮箱 (仅支持 SMTP)</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@ -156,9 +165,11 @@ yapi update -v v1<span class="token number">.1</span>.<span class="token number"
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<footer class="footer">
|
||||
<div class="copyright">
|
||||
© 2016 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
© 2017 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
@ -45,7 +45,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="plugin.html">插件Wiki</a>
|
||||
<a href="plugin.html">插件 Wiki</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo站点</a>
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo 站点</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -210,7 +210,7 @@
|
||||
|
||||
<footer class="footer">
|
||||
<div class="copyright">
|
||||
© 2016 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
© 2017 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
@ -45,7 +45,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="plugin.html">插件Wiki</a>
|
||||
<a href="plugin.html">插件 Wiki</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo站点</a>
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo 站点</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -100,7 +100,7 @@
|
||||
|
||||
|
||||
|
||||
<p class="home-version">当前版本：v1.2.3</p>
|
||||
<p class="home-version">当前版本：v1.2.4</p>
|
||||
|
||||
|
||||
</div>
|
||||
@ -116,7 +116,7 @@
|
||||
<p class="home-page-desc">YApi 让接口开发更简单高效，让接口的管理更具可读性、可维护性，让团队协作更合理。</p>
|
||||
|
||||
|
||||
<h1 class="home-page-title">功能</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
@ -129,7 +129,7 @@
|
||||
</div>
|
||||
|
||||
<h3 class="home-thumbnail-name">项目管理</h3>
|
||||
<p class="home-thumbnail-desc">YApi 成熟的团队管理，扁平化项目权限配置满足各类企业的需求</p>
|
||||
<p class="home-thumbnail-desc">YApi 成熟的团队管理<br>扁平化项目权限配置满足各类企业的需求</p>
|
||||
</div>
|
||||
|
||||
<div class="home-item">
|
||||
@ -139,7 +139,7 @@
|
||||
</div>
|
||||
|
||||
<h3 class="home-thumbnail-name">接口管理</h3>
|
||||
<p class="home-thumbnail-desc">友好的接口文档，基于 websocket 的多人协作接口编辑功能和类 postman 测试工具，让多人协作成倍提升开发效率</p>
|
||||
<p class="home-thumbnail-desc">友好的接口文档<br>基于 websocket 的多人协作接口编辑功能和类 postman 测试工具，让多人协作成倍提升开发效率</p>
|
||||
</div>
|
||||
|
||||
<div class="home-item">
|
||||
@ -149,7 +149,7 @@
|
||||
</div>
|
||||
|
||||
<h3 class="home-thumbnail-name">MockServer</h3>
|
||||
<p class="home-thumbnail-desc">基于 Mockjs，使用简单功能强大</p>
|
||||
<p class="home-thumbnail-desc">基于 Mockjs<br>使用简单功能强大</p>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@ -173,7 +173,7 @@
|
||||
|
||||
<footer class="footer">
|
||||
<div class="copyright">
|
||||
© 2016 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
© 2017 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
@ -45,7 +45,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="plugin.html">插件Wiki</a>
|
||||
<a href="plugin.html">插件 Wiki</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo站点</a>
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo 站点</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -197,7 +197,7 @@
|
||||
|
||||
<footer class="footer">
|
||||
<div class="copyright">
|
||||
© 2016 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
© 2017 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
@ -45,7 +45,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="plugin.html">插件Wiki</a>
|
||||
<a href="plugin.html">插件 Wiki</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo站点</a>
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo 站点</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -311,7 +311,7 @@
|
||||
|
||||
<footer class="footer">
|
||||
<div class="copyright">
|
||||
© 2016 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
© 2017 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
@ -45,7 +45,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="plugin.html">插件Wiki</a>
|
||||
<a href="plugin.html">插件 Wiki</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo站点</a>
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo 站点</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -139,19 +139,19 @@
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#定义 mock 数据示例">定义 mock 数据示例</a>
|
||||
<a href="#定义_mock_数据示例">定义 mock 数据示例</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#YApi-Mock 跟 Mockjs 区别">YApi-Mock 跟 Mockjs 区别</a>
|
||||
<a href="#YApi-Mock_跟_Mockjs_区别">YApi-Mock 跟 Mockjs 区别</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#如何使用 Mock">如何使用 Mock</a>
|
||||
<a href="#如何使用_Mock">如何使用 Mock</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#Mock 语法规范">Mock 语法规范</a>
|
||||
<a href="#Mock_语法规范">Mock 语法规范</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@ -359,7 +359,7 @@ name<span class="token operator">:</span> <span class="token punctuation">{</spa
|
||||
|
||||
<footer class="footer">
|
||||
<div class="copyright">
|
||||
© 2016 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
© 2017 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
<meta http-equiv="X-UA-Compatible" content="ie=edge, chrome=1">
|
||||
<meta name="description" content="description of your site">
|
||||
<meta name="author" content="author of the site">
|
||||
<title>YApi 插件Wiki</title>
|
||||
<title>YApi 插件 Wiki</title>
|
||||
<link rel="stylesheet" href="source/main.css" />
|
||||
|
||||
|
||||
@ -45,7 +45,7 @@
|
||||
|
||||
<li class="active">
|
||||
|
||||
<a href="plugin.html">插件Wiki</a>
|
||||
<a href="plugin.html">插件 Wiki</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo站点</a>
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo 站点</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -96,6 +96,12 @@
|
||||
<nav class="docs-sidebar hidden-print hidden-xs hidden-sm">
|
||||
<ul class="nav docs-sidenav">
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="redev.html">二次开发</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
@ -119,7 +125,7 @@
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#index.js 配置说明">index.js 配置说明</a>
|
||||
<a href="#index.js_配置说明">index.js 配置说明</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
@ -191,7 +197,7 @@ listener //监听函数，可以是普通函数，也可以是 asyncFunction
|
||||
|
||||
<footer class="footer">
|
||||
<div class="copyright">
|
||||
© 2016 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
© 2017 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
<meta http-equiv="X-UA-Compatible" content="ie=edge, chrome=1">
|
||||
<meta name="description" content="description of your site">
|
||||
<meta name="author" content="author of the site">
|
||||
<title>YApi 插件Wiki</title>
|
||||
<title>YApi 插件 Wiki</title>
|
||||
<link rel="stylesheet" href="source/main.css" />
|
||||
|
||||
|
||||
@ -45,7 +45,7 @@
|
||||
|
||||
<li class="active">
|
||||
|
||||
<a href="plugin.html">插件Wiki</a>
|
||||
<a href="plugin.html">插件 Wiki</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo站点</a>
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo 站点</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -96,6 +96,12 @@
|
||||
<nav class="docs-sidebar hidden-print hidden-xs hidden-sm">
|
||||
<ul class="nav docs-sidenav">
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="redev.html">二次开发</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
@ -117,11 +123,11 @@
|
||||
<ul class="nav docs-sidenav-extend" >
|
||||
|
||||
<li >
|
||||
<a href="#后端 hookList">后端 hookList</a>
|
||||
<a href="#后端_hookList">后端 hookList</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#前端 hookList">前端 hookList</a>
|
||||
<a href="#前端_hookList">前端 hookList</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@ -324,7 +330,7 @@ hooks = <span class="token punctuation">{</span>
|
||||
|
||||
<footer class="footer">
|
||||
<div class="copyright">
|
||||
© 2016 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
© 2017 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
<meta http-equiv="X-UA-Compatible" content="ie=edge, chrome=1">
|
||||
<meta name="description" content="description of your site">
|
||||
<meta name="author" content="author of the site">
|
||||
<title>YApi 插件Wiki</title>
|
||||
<title>YApi 插件 Wiki</title>
|
||||
<link rel="stylesheet" href="source/main.css" />
|
||||
|
||||
|
||||
@ -45,7 +45,7 @@
|
||||
|
||||
<li class="active">
|
||||
|
||||
<a href="plugin.html">插件Wiki</a>
|
||||
<a href="plugin.html">插件 Wiki</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo站点</a>
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo 站点</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -96,6 +96,12 @@
|
||||
<nav class="docs-sidebar hidden-print hidden-xs hidden-sm">
|
||||
<ul class="nav docs-sidenav">
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="redev.html">二次开发</a>
|
||||
</li>
|
||||
|
||||
<!-- <li class="active" class="active" > -->
|
||||
<li class="active" >
|
||||
|
||||
@ -154,7 +160,7 @@ yapi unplugin yapi-plugin-demo
|
||||
|
||||
<footer class="footer">
|
||||
<div class="copyright">
|
||||
© 2016 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
© 2017 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
<meta http-equiv="X-UA-Compatible" content="ie=edge, chrome=1">
|
||||
<meta name="description" content="description of your site">
|
||||
<meta name="author" content="author of the site">
|
||||
<title>YApi 插件Wiki</title>
|
||||
<title>YApi 插件 Wiki</title>
|
||||
<link rel="stylesheet" href="source/main.css" />
|
||||
|
||||
|
||||
@ -45,7 +45,7 @@
|
||||
|
||||
<li class="active">
|
||||
|
||||
<a href="plugin.html">插件Wiki</a>
|
||||
<a href="plugin.html">插件 Wiki</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo站点</a>
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo 站点</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -96,6 +96,12 @@
|
||||
<nav class="docs-sidebar hidden-print hidden-xs hidden-sm">
|
||||
<ul class="nav docs-sidenav">
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="redev.html">二次开发</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
@ -165,7 +171,7 @@ window.onload = function(){
|
||||
|
||||
<footer class="footer">
|
||||
<div class="copyright">
|
||||
© 2016 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
© 2017 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
<meta http-equiv="X-UA-Compatible" content="ie=edge, chrome=1">
|
||||
<meta name="description" content="description of your site">
|
||||
<meta name="author" content="author of the site">
|
||||
<title>YApi 插件Wiki</title>
|
||||
<title>YApi 插件 Wiki</title>
|
||||
<link rel="stylesheet" href="source/main.css" />
|
||||
|
||||
|
||||
@ -45,7 +45,7 @@
|
||||
|
||||
<li class="active">
|
||||
|
||||
<a href="plugin.html">插件Wiki</a>
|
||||
<a href="plugin.html">插件 Wiki</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo站点</a>
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo 站点</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -96,6 +96,12 @@
|
||||
<nav class="docs-sidebar hidden-print hidden-xs hidden-sm">
|
||||
<ul class="nav docs-sidenav">
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="redev.html">二次开发</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
@ -126,12 +132,25 @@
|
||||
|
||||
<div class="content-right markdown-body use-sidebar" role="main">
|
||||
|
||||
<h2 class="subject" id="安装">安装 <a class="hashlink" href="#安装">#</a></h2><p>假设插件名为：yapi-plugin-demo,安装方法如下：</p>
|
||||
<pre><code>cd <span class="token punctuation">{</span>项目目录<span class="token punctuation">}</span>
|
||||
yapi plugin yapi-plugin-demo
|
||||
</code></pre><h2 class="subject" id="卸载插件">卸载插件 <a class="hashlink" href="#卸载插件">#</a></h2><p>假设插件名为：yapi-plugin-demo,卸载方法如下：</p>
|
||||
<pre><code>cd <span class="token punctuation">{</span>项目目录<span class="token punctuation">}</span>
|
||||
yapi unplugin yapi-plugin-demo
|
||||
<h2 class="subject" id="运行开发服务器">运行开发服务器 <a class="hashlink" href="#运行开发服务器">#</a></h2><p>首先确保安装了 ykit, 没有安装请执行 npm install -g ykit</p>
|
||||
<pre><code>mkdir yapi
|
||||
cd yapi
|
||||
git clone https<span class="token operator">:</span>//github.com/YMFE/yapi.git vendors
|
||||
cp vendors/config_example.json ./config.json //复制完成后请修改相关配置
|
||||
cd vendors
|
||||
npm install
|
||||
node run install-server //安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
|
||||
npm run dev //启动服务器后，请访问 <span class="token number">127.0</span>.<span class="token number">0.1</span><span class="token operator">:</span><span class="token punctuation">{</span>config.json配置的端口<span class="token punctuation">}</span>，初次运行会有个编译的过程，请耐心等候
|
||||
</code></pre><h2 class="subject" id="安装成功后的目录结构">安装成功后的目录结构 <a class="hashlink" href="#安装成功后的目录结构">#</a></h2><pre><code>yapi
|
||||
config.json //服务器配置，可参考 vendors/config_example.json
|
||||
vendors //yapi
|
||||
init.lock //安装锁文件，重新安装需要删除此文件
|
||||
log //运行日志
|
||||
</code></pre><h2 class="subject" id="技术栈说明">技术栈说明 <a class="hashlink" href="#技术栈说明">#</a></h2><p>后端： koa mongoose</p>
|
||||
<p>前端： react redux</p>
|
||||
<h2 class="subject" id="启动_prd_环境服务器">启动 prd 环境服务器 <a class="hashlink" href="#启动_prd_环境服务器">#</a></h2><pre><code> cd vendors
|
||||
ykit pack -m
|
||||
node server/app.js
|
||||
</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
@ -142,7 +161,7 @@ yapi unplugin yapi-plugin-demo
|
||||
|
||||
<footer class="footer">
|
||||
<div class="copyright">
|
||||
© 2016 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
© 2017 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
@ -45,7 +45,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="plugin.html">插件Wiki</a>
|
||||
<a href="plugin.html">插件 Wiki</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo站点</a>
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo 站点</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -201,7 +201,7 @@
|
||||
|
||||
<footer class="footer">
|
||||
<div class="copyright">
|
||||
© 2016 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
© 2017 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
@ -45,7 +45,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="plugin.html">插件Wiki</a>
|
||||
<a href="plugin.html">插件 Wiki</a>
|
||||
</li>
|
||||
|
||||
<li class="active">
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo站点</a>
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo 站点</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -77,6 +77,15 @@
|
||||
|
||||
<!-- Docs page layout -->
|
||||
|
||||
<div class="ydoc-banner-bg">
|
||||
<div class="ydoc-banner ">
|
||||
<div class="ydoc-banner-area">
|
||||
<h1 >常见问题</h1>
|
||||
<p class="desc ">这里列举了常见的问题</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="ydoc-container">
|
||||
|
||||
@ -90,25 +99,25 @@
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="#Q1: 怎样联系组长？">Q1: 怎样联系组长？</a>
|
||||
<a href="#Q1__怎样联系组长？">Q1: 怎样联系组长？</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="#Q2: 怎么快速迁移旧项目？">Q2: 怎么快速迁移旧项目？</a>
|
||||
<a href="#Q2__怎么快速迁移旧项目？">Q2: 怎么快速迁移旧项目？</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="#Q3: 忘记密码怎么办？">Q3: 忘记密码怎么办？</a>
|
||||
<a href="#Q3__忘记密码怎么办？">Q3: 忘记密码怎么办？</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="#04: 发现了 Bug 怎么办？">04: 发现了 Bug 怎么办？</a>
|
||||
<a href="#04__发现了_Bug_怎么办？">04: 发现了 Bug 怎么办？</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@ -142,9 +151,11 @@
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<footer class="footer">
|
||||
<div class="copyright">
|
||||
© 2016 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
© 2017 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
@ -45,7 +45,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="plugin.html">插件Wiki</a>
|
||||
<a href="plugin.html">插件 Wiki</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo站点</a>
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo 站点</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -211,7 +211,7 @@
|
||||
|
||||
<footer class="footer">
|
||||
<div class="copyright">
|
||||
© 2016 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
© 2017 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
200
static/doc/redev.html
Normal file
200
static/doc/redev.html
Normal file
@ -0,0 +1,200 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="zh-CN">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no" />
|
||||
<meta name="format-detection" content="telephone=no,email=no" />
|
||||
<meta http-equiv="X-UA-Compatible" content="ie=edge, chrome=1">
|
||||
<meta name="description" content="description of your site">
|
||||
<meta name="author" content="author of the site">
|
||||
<title>YApi 插件 Wiki</title>
|
||||
<link rel="stylesheet" href="source/main.css" />
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="styles/theme.css" />
|
||||
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<div class="ydoc">
|
||||
<header class="ydoc-header">
|
||||
<div class="ydoc-header-area">
|
||||
|
||||
<a href="https://github.com/ymfe" class="navbar-brand">YMFE</a>
|
||||
|
||||
<button class="ydocIcon navbar-toggle"></button>
|
||||
<nav class="ydoc-nav">
|
||||
<ul class="navbar-left">
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="index.html">首页</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="usage.html">使用手册</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="devops.html">内网部署</a>
|
||||
</li>
|
||||
|
||||
<li class="active">
|
||||
|
||||
<a href="plugin.html">插件 Wiki</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="qa.html">常见问题</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="releases.html">版本记录</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo 站点</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="api.html"></a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
<!-- <header style="height:20px"></header> -->
|
||||
|
||||
<!-- Docs page layout -->
|
||||
|
||||
<div class="ydoc-banner-bg">
|
||||
<div class="ydoc-banner ">
|
||||
<div class="ydoc-banner-area">
|
||||
<h1 >插件</h1>
|
||||
<p class="desc ">可根据业务需求，定制化功能</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="ydoc-container">
|
||||
|
||||
<div class="ydoc-container-content ">
|
||||
|
||||
|
||||
<div class="content-left staticsidenav" role="complementary">
|
||||
<nav class="docs-sidebar hidden-print hidden-xs hidden-sm">
|
||||
<ul class="nav docs-sidenav">
|
||||
|
||||
<!-- <li class="active" class="active" > -->
|
||||
<li class="active" >
|
||||
|
||||
<a href="redev.html">二次开发</a>
|
||||
</li>
|
||||
|
||||
<ul class="nav docs-sidenav-extend" >
|
||||
|
||||
<li >
|
||||
<a href="#运行开发服务器">运行开发服务器</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#安装成功后的目录结构">安装成功后的目录结构</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#技术栈说明">技术栈说明</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#启动_prd_环境服务器">启动 prd 环境服务器</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="plugin-index.html">插件管理</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="plugin-dev.html">插件开发</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="plugin-hooks.html">钩子列表</a>
|
||||
</li>
|
||||
|
||||
<!-- <li > -->
|
||||
<li >
|
||||
|
||||
<a href="plugin-list.html">插件列表</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
<div class="content-right markdown-body use-sidebar" role="main">
|
||||
|
||||
<h2 class="subject" id="运行开发服务器">运行开发服务器 <a class="hashlink" href="#运行开发服务器">#</a></h2><p>首先确保安装了 ykit, 没有安装请执行 npm install -g ykit</p>
|
||||
<pre><code>mkdir yapi
|
||||
cd yapi
|
||||
git clone https<span class="token operator">:</span>//github.com/YMFE/yapi.git vendors
|
||||
cp vendors/config_example.json ./config.json //复制完成后请修改相关配置
|
||||
cd vendors
|
||||
npm install
|
||||
node run install-server //安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
|
||||
npm run dev //启动服务器后，请访问 <span class="token number">127.0</span>.<span class="token number">0.1</span><span class="token operator">:</span><span class="token punctuation">{</span>config.json配置的端口<span class="token punctuation">}</span>，初次运行会有个编译的过程，请耐心等候
|
||||
</code></pre><h2 class="subject" id="安装成功后的目录结构">安装成功后的目录结构 <a class="hashlink" href="#安装成功后的目录结构">#</a></h2><pre><code>yapi
|
||||
config.json //服务器配置，可参考 vendors/config_example.json
|
||||
vendors //yapi
|
||||
init.lock //安装锁文件，重新安装需要删除此文件
|
||||
log //运行日志
|
||||
</code></pre><h2 class="subject" id="技术栈说明">技术栈说明 <a class="hashlink" href="#技术栈说明">#</a></h2><p>后端： koa mongoose</p>
|
||||
<p>前端： react redux</p>
|
||||
<h2 class="subject" id="启动_prd_环境服务器">启动 prd 环境服务器 <a class="hashlink" href="#启动_prd_环境服务器">#</a></h2><pre><code> cd vendors
|
||||
ykit pack -m
|
||||
node server/app.js
|
||||
</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<footer class="footer">
|
||||
<div class="copyright">
|
||||
© 2017 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="open-panel"></div>
|
||||
<div class="mask"></div>
|
||||
|
||||
|
||||
<script src="source/main.js"></script>
|
||||
<script src="source/app.js"></script>
|
||||
|
||||
|
||||
</body>
|
||||
|
||||
</html>
|
||||
@ -45,7 +45,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="plugin.html">插件Wiki</a>
|
||||
<a href="plugin.html">插件 Wiki</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo站点</a>
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo 站点</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -109,7 +109,7 @@
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#Bug Fixed">Bug Fixed</a>
|
||||
<a href="#Bug_Fixed">Bug Fixed</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@ -127,7 +127,7 @@
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#Bug Fixed">Bug Fixed</a>
|
||||
<a href="#Bug_Fixed">Bug Fixed</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@ -145,7 +145,7 @@
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="#Bug Fixed">Bug Fixed</a>
|
||||
<a href="#Bug_Fixed">Bug Fixed</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@ -187,7 +187,7 @@
|
||||
<ul class="nav docs-sidenav-extend" >
|
||||
|
||||
<li >
|
||||
<a href="#Fix Bug">Fix Bug</a>
|
||||
<a href="#Fix_Bug">Fix Bug</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
@ -232,7 +232,7 @@
|
||||
|
||||
<footer class="footer">
|
||||
<div class="copyright">
|
||||
© 2016 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
© 2017 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
@ -72,9 +72,14 @@ body, h1, h2, h3, h4, h5, h6 {
|
||||
font-family: 'Dosis', 'Source Sans Pro', 'Helvetica Neue', Arial, sans-serif;
|
||||
}
|
||||
.ydoc .ydoc-banner-bg {
|
||||
background: url(https://ws1.sinaimg.cn/large/006cGJIjly1fl42tf966mj31dr0aqahp.jpg) 0 top repeat-x;
|
||||
background-color: #232323;
|
||||
/* background: url(https://ws1.sinaimg.cn/large/006cGJIjly1fl42tf966mj31dr0aqahp.jpg) 0 top repeat-x; */
|
||||
/* background-color: #232323; */
|
||||
/* background: linear-gradient(45deg,#020031 0,#6d3353 100%); */
|
||||
background: linear-gradient(45deg,#03010e 0,#a75afb 100%);
|
||||
|
||||
}
|
||||
|
||||
|
||||
.ydoc .ydoc-banner-home .home-desc{
|
||||
padding: 0 1rem .16rem;
|
||||
font-weight: normal;
|
||||
@ -128,3 +133,33 @@ body, h1, h2, h3, h4, h5, h6 {
|
||||
transform: rotate(360deg);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
.ydoc .ydoc-banner-home .home-btn{
|
||||
color: #e5e6e6;
|
||||
font-weight: 400;
|
||||
}
|
||||
|
||||
.ydoc .ydoc-banner-home .home-version{
|
||||
/* color: #969594; */
|
||||
color: #cfcdd1;
|
||||
}
|
||||
|
||||
.ydoc-header{
|
||||
background: #fff;
|
||||
}
|
||||
|
||||
.ydoc-header a, .ydoc-nav{
|
||||
color: #333;
|
||||
}
|
||||
|
||||
.ydoc-nav li a {
|
||||
padding: 0 15px;
|
||||
color: #4f2a7c;
|
||||
font-weight: 400;
|
||||
transition: all .4s;
|
||||
}
|
||||
|
||||
.ydoc .home-page-desc{
|
||||
color: #6b6868;
|
||||
}
|
||||
@ -45,7 +45,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="plugin.html">插件Wiki</a>
|
||||
<a href="plugin.html">插件 Wiki</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
<li class="">
|
||||
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo站点</a>
|
||||
<a href="http://yapi.demo.qunar.com/" target="_blank">demo 站点</a>
|
||||
</li>
|
||||
|
||||
<li class="">
|
||||
@ -190,7 +190,7 @@
|
||||
|
||||
<footer class="footer">
|
||||
<div class="copyright">
|
||||
© 2016 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
© 2017 <a href="https://github.com/ymfe/yapi">YMFE</a> Team. Build by <a href="http://ued.qunar.com/ydoc/">ydoc</a>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
32
ydocfile.js
32
ydocfile.js
@ -7,7 +7,7 @@ module.exports = {
|
||||
"instructionsUrlPath": "", //使用说明demo路径 (需要配合JS-Component注释的@instructions使用)
|
||||
"common": { // 通用默认配置，包括主页配置等
|
||||
"title": "YApi", //page title
|
||||
"footer": "© 2016 <a href=\"https://github.com/ymfe/yapi\">YMFE</a> Team. Build by <a href=\"http://ued.qunar.com/ydoc/\">ydoc</a> ", // 通用尾
|
||||
"footer": "© 2017 <a href=\"https://github.com/ymfe/yapi\">YMFE</a> Team. Build by <a href=\"http://ued.qunar.com/ydoc/\">ydoc</a> ", // 通用尾
|
||||
"home": "YMFE", // logo
|
||||
"homeUrl": "https://github.com/ymfe" // logourl
|
||||
},
|
||||
@ -34,21 +34,21 @@ module.exports = {
|
||||
"title": "为 API 开发者设计的管理平台", // 介绍板块标题
|
||||
"desc": "YApi 让接口开发更简单高效，让接口的管理更具可读性、可维护性，让团队协作更合理。" // 介绍板块描述
|
||||
},{
|
||||
"title": "功能",
|
||||
"title": "",
|
||||
"detail": {
|
||||
"type": "thumbnail", // 三列布局的介绍板块
|
||||
"content": [{ // 三列布局的内容，每项的key值非必需，但建议每列的key值一致
|
||||
"name": "项目管理", // 板块名称
|
||||
"src": "http://ojk406wln.bkt.clouddn.com/intro_muti.png", // 缩略图
|
||||
"desc": "YApi 成熟的团队管理，扁平化项目权限配置满足各类企业的需求" // 描述
|
||||
"desc": "YApi 成熟的团队管理<br>扁平化项目权限配置满足各类企业的需求" // 描述
|
||||
},{
|
||||
"name": "接口管理",
|
||||
"src": "http://ojk406wln.bkt.clouddn.com/intro_md.png",
|
||||
"desc": "友好的接口文档，基于 websocket 的多人协作接口编辑功能和类 postman 测试工具，让多人协作成倍提升开发效率"
|
||||
"desc": "友好的接口文档<br>基于 websocket 的多人协作接口编辑功能和类 postman 测试工具，让多人协作成倍提升开发效率"
|
||||
},{
|
||||
"name": "MockServer",
|
||||
"src": "http://ojk406wln.bkt.clouddn.com/intro_theme.png",
|
||||
"desc": "基于 Mockjs，使用简单功能强大"
|
||||
"desc": "基于 Mockjs<br>使用简单功能强大"
|
||||
}]
|
||||
}
|
||||
}]
|
||||
@ -147,17 +147,17 @@ module.exports = {
|
||||
{
|
||||
"name": "devops",
|
||||
"title": "内网部署",
|
||||
// "banner": {
|
||||
// "title": "YApi",
|
||||
// "description": "这里列举了 YApi 的历史版本、发布时间及变更记录，帮助你追溯到每个版本的演进过程。"
|
||||
// },
|
||||
"banner": {
|
||||
"title": "内网部署",
|
||||
"description": "部署 YApi 平台是非常容易的，即便您不懂 nodejs 或者 mongodb"
|
||||
},
|
||||
"compile": "markdown",
|
||||
"menuLevel": 2,
|
||||
"content": "./doc/page/manage/build.md"
|
||||
},
|
||||
{
|
||||
"name": "plugin",
|
||||
"title": "插件Wiki",
|
||||
"title": "插件 Wiki",
|
||||
"banner": {
|
||||
"title": "插件",
|
||||
"description": "可根据业务需求，定制化功能"
|
||||
@ -165,8 +165,12 @@ module.exports = {
|
||||
"content": {
|
||||
"sidebar": true,
|
||||
"multi": true,
|
||||
"index": "./doc/page/plugin/index.md",
|
||||
"index": "./doc/page/plugin/redev.md",
|
||||
"pages": [{
|
||||
"name": "二次开发",
|
||||
"index": "redev",
|
||||
"content": "./doc/page/plugin/redev.md"
|
||||
},{
|
||||
"name": "插件管理",
|
||||
"index": "plugin-index",
|
||||
"content": "./doc/page/plugin/index.md"
|
||||
@ -189,6 +193,10 @@ module.exports = {
|
||||
{
|
||||
"name": "qa",
|
||||
"title": "常见问题",
|
||||
"banner": {
|
||||
"title": "常见问题",
|
||||
"description": "这里列举了常见的问题"
|
||||
},
|
||||
"compile": "markdown",
|
||||
"menuLevel": 2,
|
||||
"content": "./doc/page/usage/qa.md"
|
||||
@ -205,7 +213,7 @@ module.exports = {
|
||||
"content": "./CHANGELOG.md"
|
||||
},{
|
||||
"name": "demo站点",
|
||||
"title": "demo站点",
|
||||
"title": "demo 站点",
|
||||
"url": "http://yapi.demo.qunar.com/"
|
||||
},
|
||||
{
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user