fix(docs): fix github link & syntax

README.md

@@ -1,8 +1,8 @@
 # Taitank Cross Platform Layout
 
-![Taitank Group](https://img.shields.io/badge/group-Taitank-blue.svg) [![license](https://img.shields.io/badge/license-Apache%202-blue)](https://github.com/ilikethese/Taitank/blob/main/License) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/ilikethese/Taitank/pulls) ![node](https://img.shields.io/badge/node-%3E%3D10.0.0-green.svg) [![Actions Status](https://github.com/ilikethese/Taitank/workflows/CMake/badge.svg?branch=main)](https://github.com/ilikethese/Taitank/actions) [![Codecov](https://img.shields.io/codecov/c/github/ilikethese/Taitank)](https://codecov.io/gh/ilikethese/Taitank)
+![Taitank Group](https://img.shields.io/badge/group-Taitank-blue.svg) [![license](https://img.shields.io/badge/license-Apache%202-blue)](https://github.com/Tencent/Taitank/blob/main/LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Tencent/Taitank/pulls) ![node](https://img.shields.io/badge/node-%3E%3D10.0.0-green.svg) [![Actions Status](https://github.com/Tencent/Taitank/workflows/CMake/badge.svg?branch=main)](https://github.com/Tencent/Taitank/actions) [![Codecov](https://img.shields.io/codecov/c/github/Tencent/Taitank)](https://codecov.io/gh/Tencent/Taitank)
 
-English | [简体中文](./README.zh_CN.md) | [Homepage](//tencent.github.io/ilikethese/)
+English | [简体中文](./README.zh_CN.md) | [Homepage](//tencent.github.io/Taitank/)
 
 ## Introduction
 
@@ -15,19 +15,19 @@ Taitank is now applied in 27 [Tencent](http://www.tencent.com/) apps such as Mob
 ## Advantages
 
 * Fully supported Flex
-* Fast Layout and Low memory consumpation
+* Fast Layout and Low memory consumption
 * Multi platform support
 
 ## Project structure
 
 ```text
-├── CMakeLists.txt                    # complier script.
+├── CMakeLists.txt                    # compiler script.
 ├── assets                            # assets.
 ├── benchmark                         # benchmark.
-├── examples                          # taitank layout examples.
+├── examples                          # Taitank layout examples.
 ├── javascript                        # wasm layout source code.
-├── src                               # taitank layout source code.
-├── tests                             # taitank layout test.
+├── src                               # Taitank layout source code.
+├── tests                             # Taitank layout test.
 └── toolchain                         # toolchain.
 ```
 
@@ -36,11 +36,11 @@ Taitank is now applied in 27 [Tencent](http://www.tencent.com/) apps such as Mob
 ### Preparing environment
 
 
-1. [CMake](https://cmake.org/) : build taitank layout.
+1. [CMake](https://cmake.org/) : build Taitank layout.
 2. [Android Studio](https://developer.android.com/studio) with NDK: build Android so.
 3. [Xcode](https://developer.apple.com/xcode/) with iOS sdk: build iOS so.
 4. [emscripten](https://emscripten.org/docs/getting_started/downloads.html): build wasm.
-5. [Python](https://www.python.org/): script to build taitank layout.
+5. [Python](https://www.python.org/): script to build Taitank layout.
 
 ### Build your first libiary
 

README.zh_CN.md

@@ -1,8 +1,8 @@
 # Taitank Cross Platform Layout
 
-![Taitank Group](https://img.shields.io/badge/group-Taitank-blue.svg) [![license](https://img.shields.io/badge/license-Apache%202-blue)](https://github.com/ilikethese/Taitank/blob/main/License) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/ilikethese/Taitank/pulls) ![node](https://img.shields.io/badge/node-%3E%3D10.0.0-green.svg) [![Actions Status](https://github.com/ilikethese/Taitank/workflows/CMake/badge.svg?branch=main)](https://github.com/ilikethese/Taitank/actions) [![Codecov](https://img.shields.io/codecov/c/github/ilikethese/Taitank)](https://codecov.io/gh/ilikethese/Taitank)
+![Taitank Group](https://img.shields.io/badge/group-Taitank-blue.svg) [![license](https://img.shields.io/badge/license-Apache%202-blue)](https://github.com/Tencent/Taitank/blob/main/LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Tencent/Taitank/pulls) ![node](https://img.shields.io/badge/node-%3E%3D10.0.0-green.svg) [![Actions Status](https://github.com/Tencent/Taitank/workflows/CMake/badge.svg?branch=main)](https://github.com/Tencent/Taitank/actions) [![Codecov](https://img.shields.io/codecov/c/github/Tencent/Taitank)](https://codecov.io/gh/Tencent/Taitank)
 
-[English](./README.md) | 简体中文 | [Homepage](//tencent.github.io/ilikethese/)
+[English](./README.md) | 简体中文 | [Homepage](//tencent.github.io/Taitank/)
 
 ## 介绍
 

deploy.sh

@@ -1,22 +1,21 @@
 #!/usr/bin/env sh
 
-# 确保脚本抛出遇到的错误
 set -e
 
-# 生成静态文件
+# build static files
 npm run docs:build
 
-# 进入生成的文件夹
+# cd to released document
 cd docs/.vuepress/dist
 
-# 如果是发布到自定义域名
-echo 'taitanklayout.com' > CNAME
+# deploy to custom domain
+echo 'taitank.dev' > CNAME
 
 git init
 git add -A
-git commit -m 'chore(docs): deploy'
+git commit -m 'chore(docs): deploy homepage'
 
-# 如果发布到 https://<USERNAME>.github.io/<REPO>
-git push -f [email protected]:ilikethese/Taitank.git master:gh-pages
+# push to gh-pages
+git push -f [email protected]:Tencent/Taitank.git master:gh-pages
 
 cd -

docs/.vuepress/components/Overview.vue

@@ -6,7 +6,7 @@
       <RouterLink to="/documentation/properties.html#align-content">Align Content</RouterLink>
       <RouterLink to="/documentation/properties.html#align-items">Align Items</RouterLink>
       <RouterLink to="/documentation/properties.html#align-self">Align Self</RouterLink>
-      <RouterLink to="/documentation/properties.html#aspect-ratio">Aspect Ratio</RouterLink>
+      <!-- <RouterLink to="/documentation/properties.html#aspect-ratio">Aspect Ratio</RouterLink> -->
       <RouterLink to="/documentation/properties.html#flex-direction">Flex Direction</RouterLink>
       <RouterLink to="/documentation/properties.html#flex-wrap">Flex Wrap</RouterLink>
       <RouterLink to="/documentation/properties.html#flex-basis-grow-and-shrink">Flex Basis, Grow, and Shrink</RouterLink>
@@ -17,15 +17,15 @@
       <RouterLink to="/documentation/properties.html#width-and-height">Width and Height</RouterLink></div>
     <div class="category">
       <h2>Examples</h2>
-      <RouterLink class='disabled' to="">Flexible Text</RouterLink>
-      <RouterLink class='disabled' to="">Floating Buttons</RouterLink>
-      <RouterLink class='disabled' to="">Overlays</RouterLink>
+      <RouterLink class='disabled' to="">Flex Layout</RouterLink>
+      <!-- <RouterLink class='disabled' to="">Floating Buttons</RouterLink>
+      <RouterLink class='disabled' to="">Overlays</RouterLink> -->
     </div>
     <div class="category">
       <h2>Contributing</h2>
-      <RouterLink class='disabled' to="">Opening a Pull Request</RouterLink>
-      <RouterLink class='disabled' to="">Testing</RouterLink>
-      <RouterLink class='disabled' to="">Writing Documentation</RouterLink>
+      <a href="https://github.com/Tencent/Taitank/pulls">Opening a Pull Request</a>
+      <!-- <RouterLink class='disabled' to="">Testing</RouterLink>
+      <RouterLink class='disabled' to="">Writing Documentation</RouterLink> -->
     </div>
   </div>
 </template>
@@ -37,33 +37,33 @@ export default {
 </script>
 
 <style lang="less">
-.overview-row {
-  width: auto;
-  display: flex;
-  flex-direction: row;
-  justify-content: space-between;
-  flex-wrap: wrap;
-  .category {
+  .overview-row {
+    width: auto;
     display: flex;
-    flex-direction: column;
-    margin: 1rem 0;
-    h2 {
-      font-size: 16px;
-      font-weight: 700;
-    }
-    a {
-      font-size: 16px;
-      font-weight: 500;
-      line-height: 250%;
-      color: #74a9ff;
-      &.disabled{
-        &:hover {
-          text-decoration: none;
-          cursor: default;
+    flex-direction: row;
+    justify-content: space-between;
+    flex-wrap: wrap;
+    .category {
+      display: flex;
+      flex-direction: column;
+      margin: 1rem 0;
+      h2 {
+        font-size: 16px;
+        font-weight: 700;
+      }
+      a {
+        font-size: 16px;
+        font-weight: 500;
+        line-height: 250%;
+        color: #74a9ff;
+        &.disabled{
+          &:hover {
+            text-decoration: none;
+            cursor: default;
+          }
+          color: #dcdfe6;
         }
-        color: #dcdfe6;
       }
     }
   }
-}
 </style>

docs/.vuepress/config.js

@@ -44,7 +44,7 @@ module.exports = {
                 }
             ]
         },
-        repo: "https://github.com/ilikethese/Taitank",
+        repo: "https://github.com/Tencent/Taitank",
         repoLabel: "GitHub"
     },
     plugins: [
@@ -138,4 +138,4 @@ module.exports = {
         ],
         // [require("./plugins/kityminder/index.js")]
     ]
-};
+};

docs/documentation/contributing.md

@@ -1 +1,3 @@
 # Contributing
+
+<a href="https://github.com/Tencent/Taitank/pulls">Opening a Pull Request</a>

docs/documentation/examples.md

@@ -1,3 +1,3 @@
 # Examples
 
-
+This page is under construction...

docs/documentation/overview.md

@@ -4,6 +4,6 @@ sidebarDepth: 2
 
 # Overview
 
-Welcome to Titank's documentation page. Below you will find helpful documentation covering all the features of the library. Each page comes with an interactive playground for you to explore that feature. The examples section showcases some of the most common layouts and how to build them. This is a community projects and contributions within documentation, code, and tests are more than welcome. The contributing section below covers how to get started.
+Welcome to Taitank's documentation page. This Page covers all the features supported by the engine. The properties section show all the supported attributes. The examples section showcases some of the most common examples. The contributing section guides you how to get started.
 
 <Overview />