Skip to content

Commit cef042d

Browse files
committed
docs: 修复中英文标点符号
1 parent a95b848 commit cef042d

28 files changed

+859
-68
lines changed

docs/.vitepress/config.mts

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ export default withPwa(
2525
returnToTopLabel: 'top',
2626
logo: '/logo.svg',
2727
nav,
28-
outlineTitle: 'ON THIS PAGE',
29-
outline: [1, 5],
28+
outlineTitle: '目录',
29+
outline: [2, 5],
3030
search: {
3131
provider: 'local'
3232
// provider: 'algolia',

docs/package.json

+4-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
"build": "prettier -w ./zh-CN/* && vitepress build .",
66
"preview": "vitepress preview .",
77
"fix-dot": "fixdot ./zh-CN/base/* ./zh-CN/control/* ./zh-CN/guide/* ./zh-CN/overlay/* ./index.md -d -p",
8-
"format": "prettier -w ./zh-CN/*"
8+
"format": "prettier -w ./zh-CN/*",
9+
"lint:zh": "pnpm zhlint '**/*.md' --fix"
910
},
1011
"devDependencies": {
1112
"@vite-pwa/vitepress": "^0.3.1",
@@ -17,7 +18,8 @@
1718
"prismjs": "^1.29.0",
1819
"vanilla-tilt": "^1.8.0",
1920
"vite-plugin-pwa": "^0.17.2",
20-
"vue3-baidu-map-gl": "workspace:*"
21+
"vue3-baidu-map-gl": "workspace:*",
22+
"zhlint": "^0.8.2"
2123
},
2224
"engines": {
2325
"node": ">=18.0.0"

docs/sponsor.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
## 如何赞助
1111

12-
您可以通过微信或者支付宝扫描下面二维码进行赞助,我们会在下面展示您的昵称信息如果您介意展示,也可在留言中说明
12+
您可以通过微信或者支付宝扫描下面二维码进行赞助,我们会在下面展示您的昵称信息 (如果您介意展示,也可在留言中说明)
1313

1414
非常感谢您的支持。
1515

docs/zh-CN/components/control/panorama-control.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ import { BPanoramaControl } from 'vue3-baidu-map-gl'
77
```
88

99
:::tip
10-
全景地图服务属于百度地图高级服务,需要向 [百度地图申请](https://lbs.baidu.com/apiconsole/fankui#?typeOne=%E4%BA%A7%E5%93%81%E9%9C%80%E6%B1%82&typeTwo=%E9%AB%98%E7%BA%A7%E6%9C%8D%E5%8A%A1&typeThree=JS%20API%E5%85%A8%E6%99%AF%E5%9B%BE) 才可以使用
10+
全景地图服务属于百度地图高级服务,需要向[百度地图申请](https://lbs.baidu.com/apiconsole/fankui#?typeOne=%E4%BA%A7%E5%93%81%E9%9C%80%E6%B1%82&typeTwo=%E9%AB%98%E7%BA%A7%E6%9C%8D%E5%8A%A1&typeThree=JS%20API%E5%85%A8%E6%99%AF%E5%9B%BE)才可以使用
1111
:::
1212

1313
## 组件示例
1414

15-
单独使用该组件不会显示全景地图覆盖情况,还需要搭配`BPanoramaCoverageLayer`组件使用。
15+
单独使用该组件不会显示全景地图覆盖情况,还需要搭配 `BPanoramaCoverageLayer` 组件使用。
1616

1717
:::demo
1818
control/panoramaControl

docs/zh-CN/components/layer/panorama-coverage.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ import { BPanoramaCoverageLayer } from 'vue3-baidu-map-gl'
77
```
88

99
:::tip 提示
10-
全景地图服务属于百度地图高级服务,需要向 [百度地图申请](https://lbs.baidu.com/apiconsole/fankui#?typeOne=%E4%BA%A7%E5%93%81%E9%9C%80%E6%B1%82&typeTwo=%E9%AB%98%E7%BA%A7%E6%9C%8D%E5%8A%A1&typeThree=JS%20API%E5%85%A8%E6%99%AF%E5%9B%BE) 才可以使用
10+
全景地图服务属于百度地图高级服务,需要向[百度地图申请](https://lbs.baidu.com/apiconsole/fankui#?typeOne=%E4%BA%A7%E5%93%81%E9%9C%80%E6%B1%82&typeTwo=%E9%AB%98%E7%BA%A7%E6%9C%8D%E5%8A%A1&typeThree=JS%20API%E5%85%A8%E6%99%AF%E5%9B%BE)才可以使用
1111
:::
1212

1313
## 组件示例
1414

15-
单独使用该组件无法查看全景地图,还需要搭配`BPanoramaControl`组件使用。
15+
单独使用该组件无法查看全景地图,还需要搭配 `BPanoramaControl` 组件使用。
1616

1717
:::demo 显示全景图层
1818
layer/panoramaCoverage

docs/zh-CN/components/map.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,17 @@ map/multiInstance
2424

2525
## 个性化地图
2626

27-
通过指定 `Map` 组件的 `mapStyleId`或者`mapStyleJson`来展示个性化地图,如果同时指定,`mapStyleId`会优先生效。
27+
通过指定 `Map` 组件的 `mapStyleId` 或者 `mapStyleJson` 来展示个性化地图,如果同时指定,`mapStyleId` 会优先生效。
2828

2929
::: tip 提示
3030

31-
1. 如果个性化地图没有生效,请先检查`mapStyleId``mapStyleJson`是否正确。如果是通过`mapStyleId`实现,还需要检查是否与 `ak`申请的账号一致
32-
2. 以下示例使用的 `mapStyleId` 均与 ak 和 域名绑定,无法直接复制使用。可根据示例主题名字到[百度地图个性化编辑器](https://lbsyun.baidu.com/apiconsole/custommap)创建后使用
31+
1. 如果个性化地图没有生效,请先检查 `mapStyleId``mapStyleJson` 是否正确。如果是通过 `mapStyleId` 实现,还需要检查是否与 `ak` 申请的账号一致
32+
2. 以下示例使用的 `mapStyleId` 均与 ak 和域名绑定,无法直接复制使用。可根据示例主题名字到[百度地图个性化编辑器](https://lbsyun.baidu.com/apiconsole/custommap)创建后使用
3333
:::
3434

3535
### 获取资源
3636

37-
> mapStyleId 和 mapStyleJson 获取以及相关注意事项,请访问 [百度地图个性化地图相关文档](https://lbsyun.baidu.com/index.php?title=jspopularGL/guide/custom#service-page-anchor3) 知悉
37+
> mapStyleId 和 mapStyleJson 获取以及相关注意事项,请访问[百度地图个性化地图相关文档](https://lbsyun.baidu.com/index.php?title=jspopularGL/guide/custom#service-page-anchor3)知悉
3838
3939
### 出行主题示例
4040

@@ -50,7 +50,7 @@ map/theme2
5050

5151
## 自定义地图加载中
5252

53-
默认情况下,地图加载中效果是`map loading...`文字居中。如果不能满足你的需求,你可以通过提供`loading`具名插槽来自定义地图加载中显示效果。
53+
默认情况下,地图加载中效果是 `map loading...` 文字居中。如果不能满足你的需求,你可以通过提供 `loading` 具名插槽来自定义地图加载中显示效果。
5454

5555
:::details 显示代码
5656

@@ -173,7 +173,7 @@ map/theme2
173173
| BMAP_SATELLITE_MAP | 普通卫星地图 |
174174

175175
::: warning 注意
176-
地球模式BMAP_EARTH_MAP下能支持的地图交互操作有限,如您需要卫星地图支持和标准地图BMAP_NORMAL_MAP一致的交互体验,请使用普通卫星图模式BMAP_SATELLITE_MAP
176+
地球模式 (BMAP_EARTH_MAP) 下能支持的地图交互操作有限,如您需要卫星地图支持和标准地图 (BMAP_NORMAL_MAP) 一致的交互体验,请使用普通卫星图模式 (BMAP_SATELLITE_MAP)
177177
:::
178178

179179
## displayOptions

docs/zh-CN/components/overlay/bezierCurve.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { BBezierCurve } from 'vue3-baidu-map-gl'
77
```
88

99
::: tip 提示
10-
不了解贝塞尔曲线的小伙伴可以先学习一下: https://zh-CN.javascript.info/bezier-curve
10+
不了解贝塞尔曲线的小伙伴可以先学习一下https://zh-CN.javascript.info/bezier-curve
1111
:::
1212

1313
## 组件示例

docs/zh-CN/components/overlay/infowindow.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { BInfoWindow } from 'vue3-baidu-map-gl'
77
```
88

99
::: tip 提示
10-
地图上只能同时显示一个`infoWindow`,所以当地图上有多个`infoWindow`组件同时绑定`v-model="true"`,只有最后一个 `infoWindow`组件会在地图上显示。
10+
地图上只能同时显示一个 `infoWindow`,所以当地图上有多个 `infoWindow` 组件同时绑定 `v-model="true"`,只有最后一个 `infoWindow` 组件会在地图上显示。
1111
:::
1212

1313
## 组件示例

docs/zh-CN/components/overlay/mapMask.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
控制地图元素的局部显示与隐藏
44

5-
- 局部显示:只展示指定区域的地图及地图元素poi 标注、底图、楼块等,隐藏掉区域外的地图元素以突出重点。
5+
- 局部显示:只展示指定区域的地图及地图元素 (poi 标注、底图、楼块等),隐藏掉区域外的地图元素以突出重点。
66
- 局部隐藏:隐藏掉局部区域地图元素,比如隐藏掉指定园区范围的地图元素,然后自定义叠加园区模型。
77

88
```ts

docs/zh-CN/components/overlay/marker.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ overlay/marker
1414

1515
## 动态渲染
1616

17-
有时候需要根据动态数据,渲染 marker,点击更新按钮查看效果.
17+
有时候需要根据动态数据渲染 marker点击更新按钮查看效果
1818
:::demo class="p-bottom"
1919
overlay/dyynmicMaker
2020
:::
@@ -45,11 +45,11 @@ overlay/dyynmicMaker
4545

4646
simple_red , simple_blue , loc_red , loc_blue , start , end , location
4747

48-
红色图标: red1 , red2 , red3 , red4 , red5 , red6 , red7 , red8 , red9 , red10
48+
红色图标red1red2red3red4red5red6red7red8red9red10
4949

50-
蓝色图标: blue1 , blue2 , blue3 , blue4 , blue5 , blue6 , blue7 , blue8 , blue9 , blue10
50+
蓝色图标blue1blue2blue3blue4blue5blue6blue7blue8blue9blue10
5151

52-
其余图标可根据下图自行定位裁切:
52+
其余图标可根据下图自行定位裁切
5353

5454
![https://mapopen.bj.bcebos.com/cms/react-bmap/markers_new2x_fbb9e99.png](https://mapopen.bj.bcebos.com/cms/react-bmap/markers_new2x_fbb9e99.png)
5555

docs/zh-CN/expand/bmap-draw.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
BMap Draw 是一个基于百度地图 JSAPI 的轻量级鼠标绘制库,提供了鼠标绘制、编辑、裁切、合并、复制黏贴、移动、测量等多种几何图形操作能力,助力开发者开箱即用式快速实现自己的几何图形编辑器。
44

5-
> 使用方式请参考官方文档: https://lbsyun.baidu.com/bmap-draw/
5+
> 使用方式请参考官方文档https://lbsyun.baidu.com/bmap-draw/
66
77
:::warning 注意
88
该组件库中 `BMapGL` 是异步加载,而 `bmap-draw` 中配置文件中包含同步调用 `BMapGL` 相关构造函数,所以只能使用异步加载。

docs/zh-CN/expand/mapv.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ MapVGL,是一款基于 WebGL 的地理信息可视化库,可以用来展示
44

55
本章节将演示一下通过插件的形式和 npm 形式加载 `mapv` 相关资源,并展示几个示例。
66

7-
## 结合方式:
7+
## 结合方式
88

9-
`mapv` 相关资源结合有如下两种方式:
9+
`mapv` 相关资源结合有如下两种方式
1010

11-
### 1. 通过组件库提供的插件形式内部以 cdn 方式加载
11+
### 1通过组件库提供的插件形式 (内部以 cdn 方式加载)
1212

13-
全局配置插件:
13+
全局配置插件
1414

1515
```ts
1616
// ...
@@ -19,7 +19,7 @@ app.use(baiduMap, {
1919
})
2020
```
2121

22-
或者通过组件配置插件:
22+
或者通过组件配置插件
2323

2424
```vue
2525
<template>
@@ -40,7 +40,7 @@ app.use(baiduMap, {
4040
</script>
4141
```
4242

43-
### 2. 通过 npm
43+
### 2通过 npm
4444

4545
安装
4646

@@ -75,7 +75,7 @@ mapv、mapvgl、mapvThree 均使用 umd 格式打包,而非 esm。所以通过
7575

7676
## 示例
7777

78-
> 以下示例均来自于 `mapv` 官方示例。更多示例见及文档请参考: https://mapv.baidu.com/gl/docs/index.html
78+
> 以下示例均来自于 `mapv` 官方示例。更多示例见及文档请参考https://mapv.baidu.com/gl/docs/index.html
7979
8080
### PointLayer 基础点层图
8181

docs/zh-CN/guide/com-events.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ lang: zh-CN
55

66
# 全局组件事件
77

8-
每个组件都有这两个事件。如果该组件库提供的功能不能满足开发需求,则可以通过`initd`事件暴露百度地图实例来自由的使用。
8+
每个组件都有这两个事件。如果该组件库提供的功能不能满足开发需求,则可以通过 `initd` 事件暴露百度地图实例来自由的使用。
99

1010
| 事件名 | 说明 | 类型 |
1111
| ------ | ------------------------------------------ | --------------------------- |

docs/zh-CN/guide/config.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ lang: zh-CN
1111

1212
目前支持两种方式,全局配置和组件 props 传入
1313
::: tip
14-
如果你是**全局注册**使用方式,那么`ak``apiUrl``plugins``pluginsSourceLink` 都支持两种来源全局注册配置和组件 `props` 提供,当同时指定的时候,会优先就近原则,从组件 `props` 中获取。如果全局注册配置和组件 `props` 都提供了,则会尝试合并两个配置。
14+
如果你是**全局注册**使用方式,那么 `ak``apiUrl``plugins``pluginsSourceLink` 都支持两种来源 (全局注册配置和组件 `props` 提供),当同时指定的时候,会优先就近原则,从组件 `props` 中获取。如果全局注册配置和组件 `props` 都提供了,则会尝试合并两个配置。
1515

1616
如果你是**按需加载**使用方式,则只支持组件 `props` 方式
1717
:::
1818

19-
### 1. 通过全局注册配置 ak 与 插件
19+
### 1通过全局注册配置 ak 与插件
2020

2121
全局注册 Options
2222

@@ -40,7 +40,7 @@ app.use(baiduMap, {
4040
app.mount('#app')
4141
```
4242

43-
### 2. 组件 `BMap` 传入 [`props`](/zh-CN/components/map#%E9%9D%99%E6%80%81%E7%BB%84%E4%BB%B6-props) 配置
43+
### 2组件 `BMap` 传入 [`props`](/zh-CN/components/map#%E9%9D%99%E6%80%81%E7%BB%84%E4%BB%B6-props) 配置
4444

4545
<!-- prettier-ignore -->
4646
```html{2,3}
@@ -71,7 +71,7 @@ app.mount('#app')
7171

7272
### 更换插件资源链接
7373

74-
如果需要自建或其他地址的资源链接,则可以通过该方式自定义。同样,该方式也支持两种形式:
74+
如果需要自建或其他地址的资源链接,则可以通过该方式自定义。同样,该方式也支持两种形式
7575

7676
```ts{3-6}
7777
// ...
@@ -100,7 +100,7 @@ app.use(baiduMap, {
100100

101101
除了提供的插件外,你还可以通过自定义插件扩展,自定义的插件将在地图加载完毕后执行与处理。
102102

103-
自定义的方式也很简单,你只需定义一个返回`Promise`的函数即可
103+
自定义的方式也很简单,你只需定义一个返回 `Promise` 的函数即可
104104

105105
```ts
106106
const customPlugin = () => {

docs/zh-CN/guide/installation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## 使用包管理器
44

5-
我们建议您使用包管理器如 NPM、Yarn 或 pnpm安装 Vue3 BaiduMap GL,然后您就可以使用打包工具,例如 Vite 或 webpack。
5+
我们建议您使用包管理器 (如 NPM、Yarn 或 pnpm) 安装 Vue3 BaiduMap GL,然后您就可以使用打包工具,例如 Vite 或 webpack。
66

77
::: code-group
88

@@ -24,7 +24,7 @@ npm install vue3-baidu-map-gl
2424

2525
直接通过浏览器的 HTML 标签导入 Vue3 BaiduMap GL,然后就可以使用全局变量 `Vue3baiduMapGl` 了。
2626

27-
不同的 CDN 提供商有不同的引入方式, 我们在这里以 [unpkg](https://unpkg.com)[jsDelivr](https://www.jsdelivr.com) 举例。 你也可以使用其它的 CDN 供应商。
27+
不同的 CDN 提供商有不同的引入方式,我们在这里以 [unpkg](https://unpkg.com)[jsDelivr](https://www.jsdelivr.com) 举例。你也可以使用其它的 CDN 供应商。
2828

2929
::: code-group
3030

docs/zh-CN/guide/introduction.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@
1212
</a>
1313
</div>
1414

15-
基于百度地图 JavaScript GL 版使用了 WebGL 对地图、覆盖物等进行渲染,支持 3D 视角展示地图 API 封装设计的 Vue3 组件库,开发体验良好,以优雅的方式完成百度地图的接入。
15+
基于百度地图 JavaScript GL 版 (使用了 WebGL 对地图、覆盖物等进行渲染,支持 3D 视角展示地图) API 封装设计的 Vue3 组件库,开发体验良好,以优雅的方式完成百度地图的接入。
1616

17-
## :sparkles: 特性
17+
## sparkles特性
1818

1919
- 🚀 自动加载百度地图 SDK,将百度地图繁琐的 Api 封装进组件,你只需关注组件本身
2020
- 📦 20+ 高质量的开箱即用 Vue 3 组件以及 8+ hooks 封装
@@ -29,7 +29,7 @@
2929

3030
### 组件库
3131

32-
Vue3 BaiduMap GL 可以在支持 [ES2018](https://caniuse.com/?feats=mdn-javascript_builtins_regexp_dotall,mdn-javascript_builtins_regexp_lookbehind_assertion,mdn-javascript_builtins_regexp_named_capture_groups,mdn-javascript_builtins_regexp_property_escapes,mdn-javascript_builtins_symbol_asynciterator,mdn-javascript_functions_method_definitions_async_generator_methods,mdn-javascript_grammar_template_literals_template_literal_revision,mdn-javascript_operators_destructuring_rest_in_objects,mdn-javascript_operators_spread_spread_in_destructuring,promise-finally) 的浏览器上运行。 如果您确实需要支持旧版本的浏览器,请自行添加 [Babel](https://babeljs.io/) 和相应的 Polyfill
32+
Vue3 BaiduMap GL 可以在支持 [ES2018](https://caniuse.com/?feats=mdn-javascript_builtins_regexp_dotall,mdn-javascript_builtins_regexp_lookbehind_assertion,mdn-javascript_builtins_regexp_named_capture_groups,mdn-javascript_builtins_regexp_property_escapes,mdn-javascript_builtins_symbol_asynciterator,mdn-javascript_functions_method_definitions_async_generator_methods,mdn-javascript_grammar_template_literals_template_literal_revision,mdn-javascript_operators_destructuring_rest_in_objects,mdn-javascript_operators_spread_spread_in_destructuring,promise-finally) 的浏览器上运行。如果您确实需要支持旧版本的浏览器,请自行添加 [Babel](https://babeljs.io/) 和相应的 Polyfill。
3333

3434
由于 Vue 3 不再支持 IE11,该组件库是基于 Vue3 封装,自然也不再支持 IE 浏览器。
3535
| ![IE](https://cdn.jsdelivr.net/npm/@browser-logos/edge/edge_32x32.png) | ![Firefox](https://cdn.jsdelivr.net/npm/@browser-logos/firefox/firefox_32x32.png) | ![Chrome](https://cdn.jsdelivr.net/npm/@browser-logos/chrome/chrome_32x32.png) | ![Safari](https://cdn.jsdelivr.net/npm/@browser-logos/safari/safari_32x32.png) |

docs/zh-CN/guide/quick-start.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,4 +67,4 @@ Vue3 BaiduMap GL 提供了基于 ES Module 开箱即用的 Tree Shaking 功能
6767

6868
## 开始使用
6969

70-
您可以从现在起启动您的项目。 对于每个组件或 hooks 的用法,请参考对应的文档。
70+
您可以从现在起启动您的项目。对于每个组件或 hooks 的用法,请参考对应的文档。

docs/zh-CN/hooks/useAddressGeocoder.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ hooks/useAddressGeocoder/index
1414
:::
1515

1616
:::tip
17-
在 Ts 中使用单个解析地址时,使用泛型`Point`内部可推断`point`为可推断为`Point`,从而避免读取值时 ts 的报错。
17+
在 Ts 中使用单个解析地址时,使用泛型 `Point` 内部可推断 `point` 为可推断为 `Point`,从而避免读取值时 ts 的报错。
1818

1919
```ts
2020
import { Point } from 'vue3-baidu-map-gl'
@@ -31,7 +31,7 @@ hooks/useAddressGeocoder/batch
3131
:::
3232

3333
:::tip
34-
在 Ts 中使用批量解析地址时,使用泛型`Point[]`内部可推断`point`为可推断为`Point[]`,从而避免遍历时 ts 的报错。
34+
在 Ts 中使用批量解析地址时,使用泛型 `Point[]` 内部可推断 `point` 为可推断为 `Point[]`,从而避免遍历时 ts 的报错。
3535

3636
```ts
3737
import { Point } from 'vue3-baidu-map-gl'
@@ -47,7 +47,7 @@ const { get, point, isLoading, isEmpty } = useAddressGeocoder(cal)
4747
```
4848

4949
:::tip
50-
该 hooks 依赖于 `BMapGL` ,所以需要在 `Map` 组件初始化完毕调用 `get` 方法后数据才可用
50+
该 hooks 依赖于 `BMapGL`,所以需要在 `Map` 组件初始化完毕调用 `get` 方法后数据才可用
5151
:::
5252

5353
### 参数

docs/zh-CN/hooks/useAreaBoundary.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const { isLoading, boundaries, get } = useAreaBoundary(cal)
1919
```
2020

2121
:::tip
22-
该 hooks 依赖于 `BMapGL` ,所以需要在 `Map` 组件初始化完毕调用 `get` 方法后数据才可用
22+
该 hooks 依赖于 `BMapGL`,所以需要在 `Map` 组件初始化完毕调用 `get` 方法后数据才可用
2323
:::
2424

2525
### 参数

0 commit comments

Comments
 (0)