Skip to content

Commit 9edf104

Browse files
committed
doc: add changelog
1 parent fc08114 commit 9edf104

File tree

11 files changed

+1232
-1117
lines changed

11 files changed

+1232
-1117
lines changed

CHANGELOG.zh-CN.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## 更新日志
2+
3+
`@surely-vue/table` 严格遵循 [Semantic Versioning 2.0.0](http://semver.org/lang/zh-CN/) 语义化版本规范。
4+
5+
#### 发布周期
6+
7+
- 修订版本号:每周末会进行日常 bugfix 更新。(如果有紧急的 bugfix,则任何时候都可发布)
8+
- 次版本号:每月发布一个带有新特性的向下兼容的版本。
9+
- 主版本号:含有破坏性更新和新特性,不在发布周期内。
10+
11+
---
12+
13+
## 2.0.2
14+
15+
`2021-11-26`
16+
17+
- 🌟 新增 CDN 引入支持
18+
- 🌟 优化国际化支持
19+
20+
## 2.0.1
21+
22+
`2021-11-25`
23+
24+
- 🐞 优化 package.json,减少依赖,同时避免引入不同 vue 文件问题
25+
26+
## 2.0
27+
28+
`2021-11-25`
29+
30+
🔥 🔥 🔥 正式发布
31+
32+
## 1.0
33+
34+
该版本不建议使用,可以忽略,我们直接从 2.0 开始

core

Submodule core updated from 532ff7c to ef2f8d1

package.json

+3-7
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"scripts": {
55
"predev": "node node_modules/esbuild/install.js",
66
"dev": "yarn predev && vite",
7-
"site": "yarn predev && vite build --base=https://surely.cool/",
7+
"site": "yarn predev && vite build --base=https://www.surely.cool/",
88
"pub:site": "npm run site && node scripts/pushToOSS.js",
99
"lint": "eslint -c ./.eslintrc.js --fix --ext .jsx,.vue,.ts,.tsx ./src",
1010
"tsc": "tsc --noEmit"
@@ -30,17 +30,13 @@
3030
"dist/*",
3131
"*.less"
3232
],
33-
"peerDependencies": {
34-
"ant-design-vue": "^2.0.0",
35-
"vue": "3.2.20"
36-
},
3733
"dependencies": {
3834
"@ant-design/icons-vue": "^6.0.1",
3935
"ant-design-vue": "^2.0.0",
4036
"dayjs": "^1.10.7",
4137
"lodash-es": "^4.17.21",
4238
"resize-observer-polyfill": "^1.5.1",
43-
"vue": "3.2.20"
39+
"vue": "^3.2.20"
4440
},
4541
"devDependencies": {
4642
"@babel/core": "^7.12.10",
@@ -64,7 +60,7 @@
6460
"@typescript-eslint/parser": "^4.13.0",
6561
"@vitejs/plugin-vue": "^1.0.5",
6662
"@vitejs/plugin-vue-jsx": "^1.1.5",
67-
"@vue/compiler-sfc": "3.2.20",
63+
"@vue/compiler-sfc": "^3.2.20",
6864
"@vue/eslint-config-prettier": "^6.0.0",
6965
"@vue/eslint-config-typescript": "^7.0.0",
7066
"ali-oss": "^6.13.2",

src/components/home/feature.vue

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
<div class="rec">
5050
<div class="rec-inner lay flex">
5151
<div class="left">
52-
<div class="rec-word mt-5">Ant Design Vue 团队出品 & 大厂技术专家联袂推荐</div>
52+
<div class="rec-word mt-5">CXO & 大厂技术专家联袂推荐</div>
5353
<div>
5454
<br />
5555
<a-button

src/doc/quick-start.md

+20
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,23 @@ app.use(STable);
4848
import { setLicenseKey } from '@surely-vue/table';
4949
setLicenseKey('fdafefdaffklfjajuiefhrdbfdnsafjkasyegwfpqfldfd45f48ew468fr5ds');
5050
```
51+
52+
### 模板库
53+
54+
我们创建了模板仓库供参考,或者可以直接使用该模板进行业务开发:
55+
56+
基于 Vue Cli:https://github.com/surely-vue/surely-vue-starter
57+
58+
基于 Vite:https://github.com/surely-vue/surely-vue-vite-starter
59+
60+
### CDN 引入
61+
62+
```html
63+
//css
64+
<link href="https://unpkg.com/@surely-vue/table/dist/index.min.css" rel="stylesheet" />
65+
66+
// js
67+
<script src="https://unpkg.com/@surely-vue/table"></script>
68+
```
69+
70+
对于生产环境,我们推荐链接到一个明确的版本号和构建文件,以避免新版本造成的不可预期的破坏。

src/layouts/footer.vue

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<template>
22
<a-layout-footer class="footer" style="text-align: center">
3-
Surely Vue ©2021 Created by Ant Design Vue Team
3+
Surely Vue ©2021 Created by 上海偲诺软件科技中心
44
<div style="padding: 10px 0">
55
备案号:
66
<a href="https://beian.miit.gov.cn/" target="_blank">浙ICP备19034671号-2</a>

src/layouts/nav.vue

+3
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@
2727
<a-menu-item :key="`/doc/api`">
2828
<router-link :to="`/doc/api`">API</router-link>
2929
</a-menu-item>
30+
<a-menu-item :key="`/doc/changelog`">
31+
<router-link :to="`/doc/changelog`">{{ isZhCN ? '更新日志' : 'Change Log' }}</router-link>
32+
</a-menu-item>
3033
<template v-for="demo in demos" :key="'/doc/' + demo.type">
3134
<a-sub-menu
3235
v-if="true"

src/routes.ts

+4
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ const routes = [
1717
path: 'doc/api',
1818
component: () => import('./views/api.vue'),
1919
},
20+
{
21+
path: 'doc/changelog',
22+
component: () => import('./views/changelog.vue'),
23+
},
2024
{
2125
path: 'pricing',
2226
component: () => import('./views/pricing.vue'),

src/views/basic.vue

+2
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,15 @@ import { defineComponent } from 'vue';
88
import introduction from '../doc/introduction.md';
99
import quick from '../doc/quick-start.md';
1010
import faq from '../doc/faq.md';
11+
// import changelog from '../doc/CHANGELOG.zh-CN.md';
1112
1213
export default defineComponent({
1314
name: '',
1415
components: {
1516
introduction,
1617
quick,
1718
faq,
19+
// changelog,
1820
},
1921
setup() {
2022
return {};

src/views/changelog.vue

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<template>
2+
<changelog />
3+
</template>
4+
<script lang="ts">
5+
import { defineComponent } from 'vue';
6+
import changelog from '../../CHANGELOG.zh-CN.md';
7+
8+
export default defineComponent({
9+
name: '',
10+
components: {
11+
changelog,
12+
},
13+
setup() {
14+
return {};
15+
},
16+
});
17+
</script>
18+
<style lang="less" scoped></style>

0 commit comments

Comments
 (0)