Skip to content

Commit 03f458f

Browse files
hucqhucq
committed
update
1 parent 30d285e commit 03f458f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+236
-4032
lines changed

‎.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.DS_Store
22
node_modules
33
*.log
4-
TODOs.md
54
.idea/*
65
/gitbook
76
site
7+
/docs/.vuepress/dist/*

‎deploy.sh

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
#!/usr/bin/env sh
2+
3+
# 确保脚本抛出遇到的错误
4+
set -e
5+
6+
# 生成静态文件
7+
yarn doc:build
8+
9+
# 进入生成的文件夹
10+
cd docs/.vuepress/dist
11+
# 如果是发布到自定义域名
12+
echo 'mpvue.com' > CNAME
13+
14+
git init
15+
git add -A
16+
git commit -m 'deploy'
17+
18+
# 如果发布到 https://<USERNAME>.github.io
19+
# git push -f git@github.com:hucq/hucq.github.io.git master
20+
21+
# 如果发布到 https://<USERNAME>.github.io/<REPO>
22+
git push -f git@github.com:mpvue/mpvue-docs.git master:gh-pages
23+
24+
cd -

‎docs.yml

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/.vuepress/config.js

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
module.exports = {
2+
title: 'mpvue.com',
3+
description: 'mpvue document',
4+
head: [
5+
['link', {rel: 'icon', href: '/'}]
6+
],
7+
base: '/',
8+
themeConfig: {
9+
repo: 'https://github.com/hucq/techthink',
10+
docsDir: 'docs',
11+
docsBranch: 'master',
12+
editLinks: false,
13+
14+
nav: [
15+
{
16+
text: '首页',
17+
link: '/'
18+
}, {
19+
text: 'Q&A',
20+
link: '/qa'
21+
},
22+
{
23+
text: 'build',
24+
items: [
25+
{
26+
text: 'index',
27+
link: '/build/index'
28+
}, {
29+
text: 'mpvue-webpack-target',
30+
link: '/build/mpvue-webpack-target'
31+
}, {
32+
text: 'postcss-mpvue-wxss',
33+
link: '/build/postcss-mpvue-wxss'
34+
}, {
35+
text: 'px2rpx-loader',
36+
link: '/build/px2rpx-loader'
37+
}, {
38+
text: 'mpvue-lint',
39+
link: '/build/mpvue-lint'
40+
}, {
41+
text: 'webpack-mpvue-asset-plugin',
42+
link: '/build/webpack-mpvue-asset-plugin'
43+
}
44+
]
45+
}, {
46+
text: 'mpvue',
47+
items: [{
48+
text: 'index',
49+
link: '/mpvue/index'
50+
}, {
51+
text: 'mpvue-template-compiler',
52+
link: '/mpvue/mpvue-template-compiler'
53+
}, {
54+
text: 'quickstart',
55+
link: '/mpvue/quickstart'
56+
}, {
57+
text: 'Simple',
58+
link: '/mpvue/simple'
59+
}]
60+
}, {
61+
text: 'changelog',
62+
items: [{
63+
text: 'index',
64+
link: '/change-log/index'
65+
}, {
66+
text: '2018.7.24',
67+
link: '/change-log/2018.7.24'
68+
}]
69+
}
70+
]
71+
}
72+
}
73+

‎docs/CNAME

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/index.md renamed to ‎docs/README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
1-
<script crossorigin="anonymous" src="//www.dpfile.com/app/owl/static/owl_1.5.28.js"></script>
2-
<script>
3-
Owl.start({
4-
project: 'mpvue-doc',
5-
pageUrl: 'index'
6-
})
7-
</script>
8-
<center><img src="assets/logo.png" width="120"></center>
1+
---
2+
sidebar: true
3+
---
4+
5+
<center><img src="./assets/logo.png" width="120"></center>
96
<center><img src="https://img.shields.io/npm/v/mpvue.svg?style=flat"> &nbsp;<img src="https://img.shields.io/npm/dm/mpvue.svg?style=flat"></center>
107

118
# 介绍
@@ -56,5 +53,4 @@ Owl.start({
5653
- [px2rpx-loader](/build/px2rpx-loader) 样式转化插件
5754
- [mpvue-lint](/build/mpvue-lint) 开发辅助插件，包括语法检查，内存检查等功能
5855
- 其它
59-
60-
56+
- [qa](/qa)

‎docs/_config.yml

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/build/index.md renamed to ‎docs/build/README.md

Lines changed: 32 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
<script crossorigin="anonymous" src="//www.dpfile.com/app/owl/static/owl_1.5.28.js"></script>
2-
<script>
3-
Owl.start({
4-
project: 'mpvue-doc',
5-
pageUrl: 'build/index'
6-
})
7-
</script>
1+
---
2+
sidebar: true
3+
prev: false
4+
next: false
5+
---
86

97
# 项目建构
108

@@ -13,33 +11,33 @@ Owl.start({
1311

1412
如果你不了解什么是 webpack, 可以查看 [webpack文档](https://doc.webpack-china.org/) 。
1513
用一个图来描述：
16-
``` plaintext
17-
// app.vue & main.js
18-
+---------+ +----------+ +---------+
19-
| app.vue | + | app.js | | app.json|
20-
+---------+ | +----------+ +---------+
21-
+---------------------->
22-
+---------+ | webpack +----------+
23-
| main.js | + | app.wxss |
24-
+---------+ +----------+
25-
26-
// page.vue & main.js
27-
+------------------------+
28-
v |
29-
+-----------+ +-------+ |
30-
| page.vue | +--> | .sass | |
31-
++-+-+------+ +-------+ |
32-
| | | |
33-
| | | +------------+ |
34-
| | +---> | common.css | v +------+ +-------+
35-
| | +-----+------+ | .js | | .json |
36-
| | | +---------+ +------+ +-------+
37-
| | +-----+ | | main.js | +--------->
38-
| +-> | .js | v +---------+ webpack +-------+ +-------+
39-
| +-----+ ++------+ | .wxml | | .wxss |
40-
| +------+ | .font | +-------+ +-------+
41-
+-> | .jpg | +-------+
42-
+------+
14+
``` html
15+
app.vue & main.js
16+
┌---------┐ ┌----------┐ ┌---------┐
17+
| app.vue ├--┐ | app.js | | app.json|
18+
└---------┘ | └----------┘ └---------┘
19+
├---------------------->
20+
┌---------┐ | webpack ┌----------┐
21+
| main.js ├--┘ | app.wxss |
22+
└---------┘ └----------┘
23+
24+
25+
page.vue & main.js
26+
┌------------------------------┐
27+
┌-----┴-----┐ ┌-------┐ |
28+
| page.vue ├----> | .sass | |
29+
└---┬-┬-┬---┘ └-------┘ |
30+
| | | |
31+
| | | ┌------------┐ |
32+
| | └---> | common.css | | ┌-------┐ ┌-------┐
33+
| | └-------┬----┘ v | .js | | .json |
34+
| | | ┌---------┐ └-------┘ └-------┘
35+
| | ┌------┐ | | main.js ├----------->
36+
| └-->| .js | v └---------┘ webpack ┌-------┐ ┌-------┐
37+
| └------┘ ┌-------┐ | .wxml | | .wxss |
38+
| ┌------┐ | .font | └-------┘ └-------┘
39+
└---->| .jpg | └-------┘
40+
└------┘
4341
```
4442

4543
## 懒人专用

‎docs/build/mpvue-lint.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
sidebar: true
3+
prev: false
4+
next: false
5+
---
6+
17
# mpvue-lint
28

39
>针对很多需要h5和小程序页面同构开发的场景，开发者会出现很多h5的vue组件直接搬到mpvue中调试的开发流程。虽然mpvue支持大部分的vue语法，但是仍有些边界
@@ -28,7 +34,7 @@ mpvueLint.build(
2834
lint检查非强制阻拦编译过程，FE同学自己根据提醒修改业务代码
2935

3036
运行结果如图：</br>
31-
<img src="../../assets/mpvue-lint/1.png" width="800" alt="语法检查">
37+
<img src="../assets/mpvue-lint/1.png" width="800" alt="语法检查">
3238

3339
# mpvue-trace 内存检查
3440
>内存检查模块,mpvue-trace辅助开发者检查操作时数据更新的变化，因为最后小程序更新数据需要调用setData接口，而setData小程序真机是
@@ -49,6 +55,6 @@ mpvueTrace.trace(Vue); //Vue是当前页面中的Vue实例
4955
> mpvue-lint的源码已在github上开源[github 地址请参见](https://github.com/mpvue/mpvue-lint) 欢迎开发者们根据自己项目的情况灵活增减功能
5056
5157
源码基本原理图：</br>
52-
<img src="../../assets/mpvue-lint/2.jpg" style="margin:0 auto;display:block;" width="400" alt="语法检查流程">
58+
<img src="../assets/mpvue-lint/2.jpg" style="margin:0 auto;display:block;" width="400" alt="语法检查流程">
5359

5460

‎docs/build/mpvue-loader.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
1-
<script crossorigin="anonymous" src="//www.dpfile.com/app/owl/static/owl_1.5.28.js"></script>
2-
<script>
3-
Owl.start({
4-
project: 'mpvue-doc',
5-
pageUrl: 'build/mpvue-loader'
6-
})
7-
</script>
8-
1+
---
2+
sidebar: true
3+
prev: false
4+
next: false
5+
---
96

107
# mpvue-loader
118

@@ -97,7 +94,11 @@ export default {
9794
</template>
9895
```
9996

100-
细心的开发者可能已经注意到了 `other-component(:msg="msg")` 被转化成了 `<template is="other-component$hash" data="{{ ...$c[0] }}"></template>` 。mpvue 在运行时会从根组件开始把所有的组件实例数据合并成一个树形的数据，然后通过 setData 到 appData,`$c` 是 `$children` 的缩写。至于那个 `0` 则是我们的 compiler 处理过后的一个标记，会为每一个子组件打一个特定的不重复的标记。
97+
细心的开发者可能已经注意到了 `other-component(:msg="msg")` 被转化成了
98+
``` html
99+
<template is="other-component$hash" data="{{ ...$c[0] }}"></template>
100+
```
101+
mpvue 在运行时会从根组件开始把所有的组件实例数据合并成一个树形的数据，然后通过 setData 到 appData,`$c` 是 `$children` 的缩写。至于那个 `0` 则是我们的 compiler 处理过后的一个标记，会为每一个子组件打一个特定的不重复的标记。
101102
树形数据结构如下：
102103

103104
``` javascript

‎docs/build/mpvue-webpack-target.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
<script crossorigin="anonymous" src="//www.dpfile.com/app/owl/static/owl_1.5.28.js"></script>
2-
<script>
3-
Owl.start({
4-
project: 'mpvue-doc',
5-
pageUrl: 'build/mpvue-webpack-target'
6-
})
7-
</script>
1+
---
2+
sidebar: true
3+
prev: false
4+
next: false
5+
---
86

97
# mpvue-webpack-target
108

‎docs/build/postcss-mpvue-wxss.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
<script crossorigin="anonymous" src="//www.dpfile.com/app/owl/static/owl_1.5.28.js"></script>
2-
<script>
3-
Owl.start({
4-
project: 'mpvue-doc',
5-
pageUrl: 'build/postcss-mpvue-wxss'
6-
})
7-
</script>
8-
9-
101
# PostCSS Wxss
112

123
[PostCSS] plugin for wxss.

‎docs/build/px2rpx-loader.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
<script crossorigin="anonymous" src="//www.dpfile.com/app/owl/static/owl_1.5.28.js"></script>
2-
<script>
3-
Owl.start({
4-
project: 'mpvue-doc',
5-
pageUrl: 'build/px2rpx-loader'
6-
})
7-
</script>
1+
---
2+
sidebar: true
3+
prev: false
4+
next: false
5+
---
86

97
# px2rpx-loader
108

‎docs/build/webpack-mpvue-asset-plugin.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
sidebar: true
3+
prev: false
4+
next: false
5+
---
6+
17
# webpack-mpvue-plugin
28

39
> mpvue 资源路径解析插件

‎docs/change-log/2018.7.24.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
sidebar: true
3+
prev: false
4+
next: false
5+
---
6+
17
## mpvue-loader@1.1.2-rc.4+ 升级指南
28

39
> 本次升级意在调整生成文件目录结构，对依赖的文件由原来的写死绝对路径该改为相对路径，1.1.x 版本还不是很稳定，对稳定性要求较高的项目建议暂时使用 1.0.x 版本

‎docs/change-log/index.md renamed to ‎docs/change-log/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
sidebar: true
3+
prev: false
4+
next: false
5+
---
6+
17
# Change log
28

39
## 2018.8.10

‎docs/mpvue/index.md renamed to ‎docs/mpvue/README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
<script crossorigin="anonymous" src="//www.dpfile.com/app/owl/static/owl_1.5.28.js"></script>
2-
<script>
3-
Owl.start({
4-
project: 'mpvue-doc',
5-
pageUrl: 'mpvue/index'
6-
})
7-
</script>
1+
---
2+
sidebar: true
3+
prev: false
4+
next: false
5+
---
86

97
# 使用手册
108

‎docs/mpvue/mpvue-template-compiler.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
<script crossorigin="anonymous" src="//www.dpfile.com/app/owl/static/owl_1.5.28.js"></script>
2-
<script>
3-
Owl.start({
4-
project: 'mpvue-doc',
5-
pageUrl: 'mpvue/mpvue-template-compiler'
6-
})
7-
</script>
1+
---
2+
sidebar: true
3+
prev: false
4+
next: false
5+
---
86

97
# mpvue-template-compiler
108

0 commit comments

Comments
 (0)