Skip to content

Commit

Permalink
docs: updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
zouyaoji committed Feb 8, 2022
1 parent 3980e9a commit bb0b68d
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 89 deletions.
48 changes: 12 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
<!--
* @Author: zouyaoji@https://github.com/zouyaoji
* @Date: 2021-09-03 16:57:27
* @LastEditTime: 2021-12-01 15:16:28
* @LastEditTime: 2022-02-08 13:53:41
* @LastEditors: zouyaoji
* @Description:
* @FilePath: \vue-cesium@next\README.md
-->

# VUE CESIUM

<p align="center">
<img width="300px" src="https://zouyaoji.top/vue-cesium/favicon.png">
</p>
Expand Down Expand Up @@ -37,17 +34,13 @@
- 💪 Vue 3.0 Composition API
- 🔥 Written in TypeScript

## Status: Beta

This project is still under heavy development. Feel free to join us and make your first pull request.

## Documentation
## Getting Started

You can find for more details, API, and other docs on [https://zouyaoji.top/vue-cesium/#/](https://zouyaoji.top/vue-cesium/#/)

国内码云[加速镜像站点](https://zouyaoji.gitee.io/vue-cesium/)
- 中国大陆[加速镜像站点](https://zouyaoji.gitee.io/vue-cesium/)

VueCesium supports the introduction of official CesiumJS, or other third-party platforms based on CesiumJS, Tested third-party libraries:
VueCesium supports loading the official CesiumJS, or other third-party platforms based on CesiumJS. The tested third-party libraries:

- [CesiumJS](https://cesium.com/platform/cesiumjs/)
- [SuperMap iClient3D for WebGL](http://support.supermap.com.cn:8090/webgl/web/index.html)
Expand All @@ -65,7 +58,7 @@ $ pnpm i

the project will install all dependencies and run `lerna bootstrap` to initialize the project

## Website preview
## Document preview

With command

Expand All @@ -75,34 +68,13 @@ $ pnpm website-dev

the project will launch website for you to preview all existing component

## Generate new component
With command
```bash
$ pnpm gen component-name
````

Note the `component-name` must be in `kebab-case`, combining words by replacing each space with a dash.

# Commit template

With command

```bash
pnpm cz
```

Example

```
[TYPE](SCOPE):DESCRIPTION#[ISSUE]
# example feat(viewer):add type 'viewer' for form usage #1234
```
## Licence
## License

VueCesium is open source software licensed as
[MIT](https://github.com/zouyaoji/vue-cesium/blob/master/LICENSE).

Copyright (c) 2018-present, zouyaoji 370681295@qq.com

## Sponsors

[See](https://zouyaoji.top/vue-cesium/#/en-US/donations)
Expand All @@ -114,3 +86,7 @@ This project wouldn't exist without our amazing contributors
<a href="https://github.com/zouyaoji/vue-cesium/graphs/contributors">
<img src="https://contrib.rocks/image?repo=zouyaoji/vue-cesium" />
</a>

## References

VueJS UI libraries: [quasar](https://github.com/quasarframework/quasar) and [element-plus](https://github.com/element-plus/element-plus).
50 changes: 12 additions & 38 deletions README.zh.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
<!--
* @Author: zouyaoji@https://github.com/zouyaoji
* @Date: 2021-04-29 16:12:05
* @LastEditTime: 2021-12-01 15:16:40
* @LastEditTime: 2022-02-08 13:55:12
* @LastEditors: zouyaoji
* @Description:
* @FilePath: \vue-cesium@next\README.zh.md
-->

# VUE CESIUM

<p align="center">
<img width="300px" src="https://zouyaoji.top/vue-cesium/favicon.png">
</p>
Expand Down Expand Up @@ -37,25 +34,21 @@
- 💪 Vue 3.0 Composition API
- 🔥 Written in TypeScript

## 状态: Beta

该项目仍在大力开发中。欢迎加入我们,提出您的第一个 Pull Request。

## 文档
## 开始

请访问 [https://zouyaoji.top/vue-cesium/#/](https://zouyaoji.top/vue-cesium/#/)

国内码云[加速镜像站点](https://zouyaoji.gitee.io/vue-cesium/)
- 中国大陆[加速镜像站点](https://zouyaoji.gitee.io/vue-cesium/)

VueCesium 支持引入官方 CesiumJS,或者其他基于 CesiumJS 的第三方平台,目前测试支持加载的有:
VueCesium 支持加载官方 CesiumJS,或者其他基于 CesiumJS 的第三方平台,目前通过测试平台有:

- [官方 CesiumJS](https://cesium.com/platform/cesiumjs/)
- [超图 SuperMap iClient3D for WebGL](http://support.supermap.com.cn:8090/webgl/web/index.html)
- [西部世界 Earth SDK](http://www.earthsdk.com/)
- [火星科技 Mars3D](http://mars3d.cn/)
- [数字视觉 DC-SDK](http://dc.dvgis.cn/#/index)

## 开始
## 安装

命令

Expand All @@ -65,7 +58,7 @@ $ pnpm i

将安装所有依赖,并且用 `lerna bootstrap` 初始化项目。

## 预览
## 预览文档

命令

Expand All @@ -75,36 +68,13 @@ $ pnpm website-dev

将启动站点供您预览已开发的组件和相关文档。

## 创建组件

命令

```bash
$ pnpm gen component-name
```

注意组件名称 `component-name` 必须用短横线写法 `kebab-case`

## 提交模板

命令

```bash
pnpm cz
```

例如

```
[TYPE](SCOPE):DESCRIPTION#[ISSUE]
# example feat(viewer):add type 'viewer' for form usage #1234
```

## 许可

VueCesium is open source software licensed as
[MIT](https://github.com/zouyaoji/vue-cesium/blob/master/LICENSE).

Copyright (c) 2018-present, zouyaoji 370681295@qq.com

## 捐赠者

[链接](https://zouyaoji.top/vue-cesium/#/zh-CN/donations)
Expand All @@ -116,3 +86,7 @@ VueCesium is open source software licensed as
<a href="https://github.com/zouyaoji/vue-cesium/graphs/contributors">
<img src="https://contrib.rocks/image?repo=zouyaoji/vue-cesium" />
</a>

## 参考

VueJS UI 库: [quasar](https://github.com/quasarframework/quasar)[element-plus](https://github.com/element-plus/element-plus).
17 changes: 2 additions & 15 deletions website/index.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -20,28 +20,15 @@
<script src="//at.alicdn.com/t/font_2419801_f2x68rg10b.js"></script>
<script src="https://cdn.jsdelivr.net/npm/netcdfjs@0.7.0/dist/netcdfjs.min.js"></script>
<!-- 谷歌广告 -->
<!-- <script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-3445228872340333"
crossorigin="anonymous"></script> -->
{# <!-- <script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-3445228872340333"
crossorigin="anonymous"></script> --> #}
<!-- 万维广告 -->
<meta name="wwads-cn-verify" content="a4a042cf4fd6bfb47701cbc8a1653ada" />
<!-- 友盟统计 -->
<script src="https://s4.cnzz.com/z_stat.php?id=1280816264&web_id=1280816264" async></script>
</head>
<body>
<div id="app"></div>
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-3445228872340333"
crossorigin="anonymous"></script>
<!-- vue-cesium文档底部 -->
<!-- <ins class="adsbygoogle"
style="display:block"
data-ad-client="ca-pub-3445228872340333"
data-ad-slot="1703529564"
data-ad-format="auto"
data-full-width-responsive="true">
</ins>
<script>
(adsbygoogle = window.adsbygoogle || []).push({});
</script> -->
</body>
<% if (process.env.NODE_ENV === 'production') { %><script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
Expand Down

0 comments on commit bb0b68d

Please sign in to comment.