docs(docs): updated docs

zouyaoji · Apr 29, 2021 · 48b39a8 · 48b39a8
1 parent 7b573b4
commit 48b39a8
Show file tree

Hide file tree

Showing 146 changed files with 4,055 additions and 4,131 deletions.
diff --git a/CHANGELOG.en-US.md b/CHANGELOG.en-US.md
@@ -1,9 +1,21 @@
 ## Changelog
 
+### 3.0.1-beta.5.2
+*2021-04-29*
+
+#### New feature
+
+- `vc-overlay-html`, Load HTML element overlays by geographic location.
+
+#### Optimization
+
+- Improve some English documents.
+- The language of Vetur's smart prompt is changed to English by default.
+
 ### 3.0.1-beta.4
 *2021-04-26*
 
-#### Bug 修复
+#### Bug fixes
 
 - Document search function.
 - The intellisense  of Vetur is invalid.

diff --git a/CHANGELOG.zh-CN.md b/CHANGELOG.zh-CN.md
@@ -1,5 +1,17 @@
 ## 更新日志
 
+### 3.0.1-beta.5.2
+*2021-04-29*
+
+#### 新特性
+
+- `vc-overlay-html`, 按地理位置加载 HTML 元素覆盖物。
+
+#### 优化
+
+- 完善英文部分文档。
+- Vetur 智能提示语言默认改为英文。
+
 ### 3.0.1-beta.4
 *2021-04-26*
 

diff --git a/README.md b/README.md
@@ -5,19 +5,19 @@
 </p>
 
 <p align="center">
-  <a href="https://travis-ci.org/zouyaoji/vue-cesium">
-    <img src="https://img.shields.io/travis/zouyaoji/vue-cesium?style=plastic">
+  <a href="https://github.com/zouyaoji/vue-cesium/actions/workflows/publish-npm.yml" target="_blank">
+    <img src="https://img.shields.io/github/workflow/status/zouyaoji/vue-cesium/Publish%20to%20NPM%20registry?style=plastic">
   </a>
-  <a href="https://www.npmjs.com/package/vue-cesium">
-    <img src="https://img.shields.io/npm/v/vue-cesium?style=plastic">
+  <a href="https://www.npmjs.com/package/vue-cesium" target="_blank">
+    <img src="https://img.shields.io/npm/v/vue-cesium/next?style=plastic">
   </a>
-  <a href="https://www.npmjs.com/package/vue-cesium">
+  <a href="https://npmcharts.com/compare/vue-cesium?minimal=true" target="_blank">
     <img src="https://img.shields.io/npm/dm/vue-cesium?style=plastic">
   </a>
-  <a href="https://github.com/zouyaoji/vue-cesium/blob/dev/LICENSE">
+  <a href="https://github.com/zouyaoji/vue-cesium/blob/dev/LICENSE" target="_blank">
     <img src="https://img.shields.io/github/license/zouyaoji/vue-cesium?style=plastic">
   </a>
-  <a href="https://coveralls.io/github/zouyaoji/vue-cesium?branch=dev">
+  <a href="https://coveralls.io/github/zouyaoji/vue-cesium?branch=dev" target="_blank">
     <img src="https://img.shields.io/coveralls/github/zouyaoji/vue-cesium?style=plastic">
   </a>
   <br>

diff --git a/README.zh.md b/README.zh.md
@@ -5,19 +5,19 @@
 </p>
 
 <p align="center">
-  <a href="https://travis-ci.org/zouyaoji/vue-cesium">
-    <img src="https://img.shields.io/travis/zouyaoji/vue-cesium?style=plastic">
+  <a href="https://github.com/zouyaoji/vue-cesium/actions/workflows/publish-npm.yml" target="_blank">
+    <img src="https://img.shields.io/github/workflow/status/zouyaoji/vue-cesium/Publish%20to%20NPM%20registry?style=plastic">
   </a>
-  <a href="https://www.npmjs.com/package/vue-cesium">
-    <img src="https://img.shields.io/npm/v/vue-cesium?style=plastic">
+  <a href="https://www.npmjs.com/package/vue-cesium" target="_blank">
+    <img src="https://img.shields.io/npm/v/vue-cesium/next?style=plastic">
   </a>
-  <a href="https://www.npmjs.com/package/vue-cesium">
+  <a href="https://npmcharts.com/compare/vue-cesium?minimal=true" target="_blank">
     <img src="https://img.shields.io/npm/dm/vue-cesium?style=plastic">
   </a>
-  <a href="https://github.com/zouyaoji/vue-cesium/blob/dev/LICENSE">
+  <a href="https://github.com/zouyaoji/vue-cesium/blob/dev/LICENSE" target="_blank">
     <img src="https://img.shields.io/github/license/zouyaoji/vue-cesium?style=plastic">
   </a>
-  <a href="https://coveralls.io/github/zouyaoji/vue-cesium?branch=dev">
+  <a href="https://coveralls.io/github/zouyaoji/vue-cesium?branch=dev" target="_blank">
     <img src="https://img.shields.io/coveralls/github/zouyaoji/vue-cesium?style=plastic">
   </a>
   <br>

diff --git a/website/components/header.vue b/website/components/header.vue
@@ -6,19 +6,31 @@
           <router-link :to="`/${lang}`">
             <!-- logo -->
             <slot>
-              <img
-                src="../assets/images/vue-cesium-logo.svg"
-                alt="vue-cesium-logo"
-                class="nav-logo"
-              >
-              <img
-                src="../assets/images/vue-cesium-logo-small.svg"
-                alt="element-logo"
-                class="nav-logo-small"
-              >
+              <img src="../assets/images/vue-cesium-logo.svg" alt="vue-cesium-logo" class="nav-logo">
+              <img src="../assets/images/vue-cesium-logo-small.svg" alt="element-logo" class="nav-logo-small">
             </slot>
           </router-link>
         </h1>
+        <h1>
+          <a href="https://www.npmjs.com/package/vue-cesium" target="_blank">
+            <img src="https://img.shields.io/npm/v/vue-cesium/next?style=plastic">
+          </a>
+        </h1>
+        <h1>
+          <a href="https://npmcharts.com/compare/vue-cesium?minimal=true" target="_blank">
+            <img src="https://img.shields.io/npm/dm/vue-cesium?style=plastic">
+          </a>
+        </h1>
+        <h1>
+          <a href="https://github.com/zouyaoji/vue-cesium/stargazers" target="_blank">
+            <img src="https://img.shields.io/github/stars/zouyaoji/vue-cesium?style=social">
+          </a>
+        </h1>
+        <h1>
+          <a href="https://github.com/zouyaoji/vue-cesium/issues" target="_blank">
+            <img src="https://img.shields.io/github/issues/zouyaoji/vue-cesium">
+          </a>
+        </h1>
 
         <!-- nav -->
         <ul class="nav">
@@ -52,29 +64,14 @@
           </li>
 
           <!-- 版本选择器 -->
-          <li
-            v-if="false"
-            v-show="isComponentPage"
-            class="nav-item nav-versions"
-          >
-            <el-dropdown
-              trigger="click"
-              class="nav-dropdown"
-              :class="{ 'is-active': verDropdownVisible }"
-            >
+          <li v-if="false" v-show="isComponentPage" class="nav-item nav-versions">
+            <el-dropdown trigger="click" class="nav-dropdown" :class="{ 'is-active': verDropdownVisible }">
               <span>
                 {{ version }}
                 <i class="el-icon-arrow-down el-icon--right"></i>
               </span>
-              <el-dropdown-menu
-                class="nav-dropdown-list"
-                @input="handleVerDropdownToggle"
-              >
-                <el-dropdown-item
-                  v-for="item in Object.keys(versions)"
-                  :key="item"
-                  @click="switchVersion(item)"
-                >
+              <el-dropdown-menu class="nav-dropdown-list" @input="handleVerDropdownToggle">
+                <el-dropdown-item v-for="item in Object.keys(versions)" :key="item" @click="switchVersion(item)">
                   {{ item }}
                 </el-dropdown-item>
               </el-dropdown-menu>
@@ -83,25 +80,14 @@
 
           <!-- 语言选择器 -->
           <li class="nav-item lang-item">
-            <el-dropdown
-              trigger="click"
-              class="nav-dropdown nav-lang"
-              :class="{ 'is-active': langDropdownVisible }"
-            >
+            <el-dropdown trigger="click" class="nav-dropdown nav-lang" :class="{ 'is-active': langDropdownVisible }">
               <span>
                 {{ displayedLang }}
                 <i class="el-icon-arrow-down el-icon--right"></i>
               </span>
               <template #dropdown>
-                <el-dropdown-menu
-                  class="nav-dropdown-list"
-                  @input="handleLangDropdownToggle"
-                >
-                  <el-dropdown-item
-                    v-for="(value, key) in langs"
-                    :key="key"
-                    @click="switchLang(key)"
-                  >
+                <el-dropdown-menu class="nav-dropdown-list" @input="handleLangDropdownToggle">
+                  <el-dropdown-item v-for="(value, key) in langs" :key="key" @click="switchLang(key)">
                     {{ value }}
                   </el-dropdown-item>
                 </el-dropdown-menu>
@@ -122,7 +108,7 @@ const version = '1.0.0' // element version
 
 export default {
   components: {
-    AlgoliaSearch,
+    AlgoliaSearch
   },
   data() {
     return {
@@ -133,8 +119,8 @@ export default {
       langDropdownVisible: true,
       langs: {
         [Language.CN]: '中文',
-        [Language.EN]: 'English',
-      },
+        [Language.EN]: 'English'
+      }
     }
   },
 
@@ -150,7 +136,7 @@ export default {
     },
     isComponentPage() {
       return /^component/.test(this.$route.name)
-    },
+    }
   },
   created() {
     // const xhr = new XMLHttpRequest()
@@ -184,8 +170,8 @@ export default {
 
     handleLangDropdownToggle(visible) {
       this.langDropdownVisible = visible
-    },
-  },
+    }
+  }
 }
 </script>
 <style lang="scss" scoped>
@@ -219,6 +205,7 @@ export default {
     float: left;
     font-size: 32px;
     font-weight: normal;
+    margin-right: 10px;
 
     a {
       color: #333;

diff --git a/website/components/search.vue b/website/components/search.vue
@@ -85,7 +85,6 @@ export default {
       if (!query) return
       this.index.search(query, { hitsPerPage: 12 }).then(res => {
         if (res.hits.length > 0) {
-          console.log(res.hits)
           this.isEmpty = false
           cb(
             res.hits

diff --git a/website/demo-styles/index.scss b/website/demo-styles/index.scss
@@ -1,8 +1,9 @@
 @import 'element-theme-chalk/src/mixins/config.scss';
 @import 'vc-viewer.scss';
-@import 'vc-navigation.scss';
+// @import 'vc-navigation.scss';
 @import 'vc-layer-imagery.scss';
 @import 'vc-datasource-custom.scss';
+@import 'vc-overlay-html.scss';
 
 .demo-block {
   font-weight: 400;
@@ -12,6 +13,7 @@
   .demo-viewer {
     width: 100%;
     height: 500px;
+    overflow: hidden;
 
     .demo-toolbar {
       position: absolute;

diff --git a/website/demo-styles/vc-datasource-custom.scss b/website/demo-styles/vc-datasource-custom.scss
@@ -1,28 +1,4 @@
 .demo-block.demo-vc-datasource-custom {
-  .#{$namespace}-row {
-    border-radius: 100px;
-    align-items: baseline;
-
-    &:last-child {
-      margin-bottom: 0;
-    }
-  }
-  .#{$namespace}-button {
-    margin: 10px 10px 10px 0;
-
-    &:first-child {
-      margin-left: 20px;
-    }
-  }
-
-  .#{$namespace}-switch {
-    margin: 20px 20px 20px 0;
-
-    &:first-child {
-      margin-left: 20px;
-    }
-  }
-
   .#{$namespace}-switch__label.is-active {
     color: #409eff;
   }

diff --git a/website/demo-styles/vc-viewer.scss b/website/demo-styles/vc-viewer.scss
@@ -1,20 +1,4 @@
 .demo-block.demo-vc-viewer {
-  .#{$namespace}-row {
-    border-radius: 100px;
-    align-items: baseline;
-
-    &:last-child {
-      margin-bottom: 0;
-    }
-  }
-  .#{$namespace}-button {
-    margin: 10px 10px 10px 0;
-
-    &:first-child {
-      margin-left: 20px;
-    }
-  }
-
   .#{$namespace}-switch {
     margin: 20px 20px 20px 0;