Skip to content

Commit

Permalink
doc: 更改中文名称为英文
Browse files Browse the repository at this point in the history
  • Loading branch information
wll8 committed Dec 3, 2020
1 parent 25cfbbc commit 20a7920
Show file tree
Hide file tree
Showing 19 changed files with 918 additions and 992 deletions.
38 changes: 19 additions & 19 deletions doc/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ module.exports = {
sidebarDepth: 2,
nav: [
{ text: '版本 v1.1.3', link: '/' },
{ text: '配置项', link: '/config/选项' },
{ text: '配置项', link: '/config/option.md' },
// {
// text: '源码',
// link: 'https://github.com/wll8/mockm',
Expand All @@ -85,13 +85,13 @@ module.exports = {
title: `项目开始`,
collapsable: false,
description : `项目开始前的问题`,
path: `/process/开始`,
path: `/process/start.md`,
},
{
title: `联调过程`,
collapsable: false,
description : `联调过程中的问题`,
path: `/process/过程`,
path: `/process/process.md`,
},
]
},
Expand All @@ -103,37 +103,37 @@ module.exports = {
title: `安装`,
collapsable: false,
description : `各种安装方式, 可能遇到的问题`,
path: `/use/安装`,
path: `/use/install.md`,
},
{
title: `运行`,
collapsable: false,
description : `运行以及问题`,
path: `/use/运行`,
path: `/use/run.md`,
},
{
title: `预览`,
collapsable: false,
description : `请求一个接口, 查看请求头, 及调试页面`,
path: `/use/预览`,
path: `/use/preview.md`,
},
{
title: `上手尝试`,
collapsable: false,
description : `创建配置, 添加接口`,
path: `/use/尝试`,
path: `/use/try.md`,
},
{
title: `web 界面`,
collapsable: false,
description : `关于 web 界面上的功能讲解`,
path: `/use/webui`,
path: `/use/webui.md`,
},
{
title: `生成的文件`,
collapsable: false,
description : `生成在系统上的文件及目录`,
path: `/use/outfile`,
path: `/use/outfile.md`,
},
]
},
Expand All @@ -145,25 +145,25 @@ module.exports = {
title: `命令行`,
collapsable: false,
description : `与配置文件的不同, 以及优先及, 可时该用`,
path: `/config/命令行`,
path: `/config/cli.md`,
},
{
title: `配置文件`,
collapsable: false,
description : `各种使用方式`,
path: `/config/配置文件`,
path: `/config/config_file.md`,
},
{
title: `配置项`,
collapsable: false,
description : `各个配置项讲解`,
path: `/config/选项`,
path: `/config/option.md`,
},
{
title: `综合示例`,
collapsable: false,
description : `一些业务示例`,
path: `/config/示例`,
path: `/config/example.md`,
},
]
},
Expand All @@ -176,13 +176,13 @@ module.exports = {
title: `config 作为函数`,
collapsable: false,
description : `config 作为函数时提供的工具`,
path: `/config/config_fn`,
path: `/config/config_fn.md`,
},
{
title: `config.api 作为函数`,
collapsable: false,
description : `config.api 作为函数时提供的工具`,
path: `/config/config_api_fn`,
path: `/config/config_api_fn.md`,
},
]
},
Expand All @@ -195,25 +195,25 @@ module.exports = {
title: `更新日志`,
collapsable: false,
description : `时间表, 功能更新, bug修复`,
path: `/dev/更新日志`,
path: `/dev/change_log.md`,
},
{
title: `待完成`,
collapsable: false,
description : `要完成的, 进行中的, 受阻碍的, 期待获得帮助`,
path: `/dev/待完成`,
path: `/dev/todo.md`,
},
{
title: `贡献表`,
collapsable: false,
description : `记录除自己以外的贡献者`,
path: `/dev/贡献表`,
path: `/dev/contribution.md`,
},
{
title: `实现`,
collapsable: false,
description : `讲解项目结构, 运作方式, 注意点, 用于帮助他人参考或贡献`,
path: `/dev/实现`,
path: `/dev/realize.md`,
},
]
},
Expand Down
56 changes: 28 additions & 28 deletions doc/config/命令行.md → doc/config/cli.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# 命令行参数
某些情况下, 通过命令行传入可能更简便, 支持 [配置选项](../config/选项.md) 中的以下值类型:
- string
- boolean
- number

示例:
``` sh
mm proxy=http://www.httpbin.org/
```

对应配置 config.proxy:
``` json
{
"proxy": "http://www.httpbin.org/"
}
```

当命令行参数与文件配置冲突时, 命令行参数优先.

命令行有一些额外的参数来实现配置文件之外的功能:
- v 输出版本号
- config 指定配置文件地址.
- watch 指定一些目录或文件, 当它们被修改时自动重载 mm, 多个使用逗号分隔.

::: tip
命令行上传入 config 却没有给出具体值时(`mm config`), 如果当前目录不存在配置文件, 会以默认参数生成 `mm.config.js` 作为模板供你使用. 然后按你的需求修改此文件即可.
:::
# 命令行参数
某些情况下, 通过命令行传入可能更简便, 支持 [配置选项](../config/option.md) 中的以下值类型:
- string
- boolean
- number

示例:
``` sh
mm proxy=http://www.httpbin.org/
```

对应配置 config.proxy:
``` json
{
"proxy": "http://www.httpbin.org/"
}
```

当命令行参数与文件配置冲突时, 命令行参数优先.

命令行有一些额外的参数来实现配置文件之外的功能:
- v 输出版本号
- config 指定配置文件地址.
- watch 指定一些目录或文件, 当它们被修改时自动重载 mm, 多个使用逗号分隔.

::: tip
命令行上传入 config 却没有给出具体值时(`mm config`), 如果当前目录不存在配置文件, 会以默认参数生成 `mm.config.js` 作为模板供你使用. 然后按你的需求修改此文件即可.
:::
42 changes: 21 additions & 21 deletions doc/config/配置文件.md → doc/config/config_file.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# 配置文件
mockm 支持 js 类型的配置文件.

**mm.config.js**
``` js
module.exports = {
port: 9000
}
```

作为函数使用的时候, 可以获取 mm 提供的 [工具库](../config/config_fn.md).

``` js
module.exports = util => {
return {
port: 9000
}
}
```

上面的文件中, 将 mockm 接口服务的端口号配置为 9000, 更多的配置请参考 [配置项](../config/选项.md#config-port).
# 配置文件
mockm 支持 js 类型的配置文件.

**mm.config.js**
``` js
module.exports = {
port: 9000
}
```

作为函数使用的时候, 可以获取 mm 提供的 [工具库](../config/config_fn.md).

``` js
module.exports = util => {
return {
port: 9000
}
}
```

上面的文件中, 将 mockm 接口服务的端口号配置为 9000, 更多的配置请参考 [配置项](../config/option.md#config-port).
2 changes: 1 addition & 1 deletion doc/config/config_fn.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# config 作为函数
[配置](./配置文件.md#js) 为函数的时候, 会向函数传入一个 util 对象:.
[配置](./config_file.md#js) 为函数的时候, 会向函数传入一个 util 对象:.
util 目前包含以下内容:

## util.libObj 第三方库
Expand Down
File renamed without changes.
Loading

0 comments on commit 20a7920

Please sign in to comment.