docs(website): add simplifed chinese (#1166)

* docs(website): add simplifed chinese * docs: format some documentations
asdf-vm · Jan 27, 2022 · 06d469e · 06d469e
1 parent b7dd291
commit 06d469e
Show file tree

Hide file tree

Showing 25 changed files with 2,096 additions and 32 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -14,6 +14,11 @@ module.exports = {
       lang: "pt-br",
       title: "asdf",
       description: "Gerencie múltiplas versões com um simples CLI"
+    },
+    "/zh-hans/": {
+      lang: "zh-CN",
+      title: "asdf",
+      description: "管理多个运行环境版本的简单命令行工具"
     }
   },
 
@@ -38,6 +43,17 @@ module.exports = {
         // 404 page
         notFound: ["Parece que estamos perdido!"],
         backToHome: "Voltar para a página inicial"
+      },
+      "/zh-hans/": {
+        selectLanguageName: "简体中文",
+        selectLanguageText: "选择语言",
+        sidebar: sidebar.zh_hans,
+        navbar: navbar.zh_hans,
+        editLinkText: "在 Github 编辑此页面",
+
+        // 404 page
+        notFound: ["抱歉，您访问的页面不存在！"],
+        backToHome: "返回首页"
       }
     }
   },
@@ -52,6 +68,9 @@ module.exports = {
           },
           "/pt-br/": {
             placeholder: "Search"
+          },
+          "/zh-hans/": {
+            placeholder: "搜索"
           }
         }
       }

diff --git a/docs/.vuepress/navbar.js b/docs/.vuepress/navbar.js
@@ -259,4 +259,136 @@ const pt_br = [
   }
 ];
 
-module.exports = { en, pt_br };
+const zh_hans = [
+  {
+    text: "快速上手",
+    link: "/zh-hans/guide/getting-started.html",
+    activeMatch: "/zh-hans/guide/"
+  },
+  {
+    text: "参考",
+    children: [
+      {
+        text: "管理",
+        children: [
+          "/zh-hans/manage/core.md",
+          "/zh-hans/manage/plugins.md",
+          "/zh-hans/manage/versions.md",
+          "/zh-hans/manage/configuration.md",
+          "/zh-hans/manage/commands.md",
+          {
+            text: "更新日志",
+            link: "https://github.com/asdf-vm/asdf/blob/master/CHANGELOG.md"
+          }
+        ]
+      }
+    ]
+  },
+  {
+    text: "插件",
+    children: [
+      {
+        text: "成为作者",
+        children: [
+          "/zh-hans/plugins/create.md",
+          {
+            text: "插件模板",
+            link: "https://github.com/asdf-vm/asdf-plugin-template"
+          }
+        ]
+      },
+      {
+        text: "官方插件",
+        children: [
+          {
+            text: "Elixir",
+            link: "https://github.com/asdf-vm/asdf-elixir"
+          },
+          {
+            text: "Erlang",
+            link: "https://github.com/asdf-vm/asdf-erlang"
+          },
+          {
+            text: "Node.js",
+            link: "https://github.com/asdf-vm/asdf-nodejs"
+          },
+          {
+            text: "Ruby",
+            link: "https://github.com/asdf-vm/asdf-ruby"
+          }
+        ]
+      },
+      {
+        text: "社区插件",
+        children: [
+          {
+            text: "asdf-community",
+            link: "https://github.com/asdf-community"
+          },
+          {
+            text: "GitHub 主题搜索",
+            link: "https://github.com/topics/asdf-plugin"
+          }
+        ]
+      },
+      {
+        text: "参考",
+        children: [
+          {
+            text: "插件缩写索引",
+            link: "https://github.com/asdf-vm/asdf-plugins"
+          }
+        ]
+      }
+    ]
+  },
+  {
+    text: "如何贡献",
+    children: [
+      {
+        text: "核心",
+        children: [
+          "/zh-hans/contribute/core.md",
+          "/zh-hans/contribute/documentation.md"
+        ]
+      },
+      {
+        text: "插件",
+        children: ["/zh-hans/contribute/first-party-plugins.md"]
+      },
+      {
+        text: "持续集成/持续部署",
+        children: ["/zh-hans/contribute/github-actions.md"]
+      }
+    ]
+  },
+  {
+    text: "了解更多",
+    children: [
+      {
+        text: "提问",
+        children: [
+          "/zh-hans/learn-more/faq.md",
+          {
+            text: "GitHub Issues",
+            link: "https://github.com/asdf-vm/asdf/issues"
+          },
+          {
+            text: "GitHub Discussions",
+            link: "https://github.com/asdf-vm/asdf/discussions"
+          },
+          {
+            text: "StackOverflow Tag",
+            link: "https://stackoverflow.com/questions/tagged/asdf-vm"
+          }
+        ]
+      },
+      {
+        text: "资源",
+        children: ["/zh-hans/learn-more/thanks.md"]
+      }
+    ]
+  }
+];
+
+module.exports = { en, pt_br, zh_hans };
diff --git a/docs/.vuepress/sidebar.js b/docs/.vuepress/sidebar.js
@@ -215,4 +215,118 @@ const pt_br = {
   ]
 };
 
-module.exports = { en, pt_br };
+const zh_hans = {
+  "/zh-hans/guide/": [
+    "/zh-hans/guide/introduction.md",
+    "/zh-hans/guide/getting-started.md"
+  ],
+  "/zh-hans/manage/": [
+    {
+      text: "管理",
+      children: [
+        "/zh-hans/manage/core.md",
+        "/zh-hans/manage/plugins.md",
+        "/zh-hans/manage/versions.md",
+        "/zh-hans/manage/configuration.md",
+        "/zh-hans/manage/commands.md",
+        {
+          text: "更新日志",
+          link: "https://github.com/asdf-vm/asdf/blob/master/CHANGELOG.md"
+        }
+      ]
+    }
+  ],
+  "/zh-hans/plugins/": [
+    {
+      text: "成为作者",
+      children: [
+        "/zh-hans/plugins/create.md",
+        {
+          text: "GitHub Plugin 模板",
+          link: "https://github.com/asdf-vm/asdf-plugin-template"
+        }
+      ]
+    },
+    {
+      text: "官方插件",
+      children: [
+        {
+          text: "Elixir",
+          link: "https://github.com/asdf-vm/asdf-elixir"
+        },
+        {
+          text: "Erlang",
+          link: "https://github.com/asdf-vm/asdf-erlang"
+        },
+        {
+          text: "Node.js",
+          link: "https://github.com/asdf-vm/asdf-nodejs"
+        },
+        {
+          text: "Ruby",
+          link: "https://github.com/asdf-vm/asdf-ruby"
+        }
+      ]
+    },
+    {
+      text: "社区插件",
+      children: [
+        {
+          text: "asdf-community",
+          link: "https://github.com/asdf-community/"
+        },
+        {
+          text: "GitHub 主题搜索",
+          link: "https://github.com/topics/asdf-plugin"
+        }
+      ]
+    },
+    {
+      text: "参考",
+      children: [
+        {
+          text: "插件缩写索引",
+          link: "https://github.com/asdf-vm/asdf-plugins"
+        }
+      ]
+    }
+  ],
+  "/zh-hans/contribute/": [
+    {
+      text: "如何贡献",
+      children: [
+        "/zh-hans/contribute/core.md",
+        "/zh-hans/contribute/documentation.md",
+        "/zh-hans/contribute/first-party-plugins.md",
+        "/zh-hans/contribute/github-actions.md"
+      ]
+    }
+  ],
+  "/zh-hans/learn-more/": [
+    {
+      text: "常见问题",
+      children: [
+        "/zh-hans/learn-more/faq.md",
+
+        {
+          text: "GitHub Issues",
+          link: "https://github.com/asdf-vm/asdf/issues"
+        },
+        {
+          text: "GitHub Discussions",
+          link: "https://github.com/asdf-vm/asdf/discussions"
+        },
+        {
+          text: "StackOverflow Tag",
+          link: "https://stackoverflow.com/questions/tagged/asdf-vm"
+        }
+      ]
+    },
+    {
+      text: "资源",
+      children: ["/zh-hans/learn-more/thanks.md"]
+    }
+  ]
+};
+
+module.exports = { en, pt_br, zh_hans };
diff --git a/docs/contribute/core.md b/docs/contribute/core.md
@@ -94,10 +94,10 @@ feat!: feature with breaking change
 
 The full list of `<types>` are: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`, `revert`.
 
-* `!`: indicates a breaking change
-* `fix`: will create a new SemVer `patch`
-* `feat`: will create a new SemVer `minor`
-* `<type>!`: will create a new SemVer `major`
+- `!`: indicates a breaking change
+- `fix`: will create a new SemVer `patch`
+- `feat`: will create a new SemVer `minor`
+- `<type>!`: will create a new SemVer `major`
 
 The Pull Request Title must follow this format.
 

diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md
@@ -17,8 +17,8 @@
 `sudo` may be required depending on your system configuration.
 :::
 
-| Package Manager | Command                        |
-| --------------- | ------------------------------ |
+| Package Manager | Command                   |
+| --------------- | ------------------------- |
 | Aptitude        | `apt install curl git`    |
 | DNF             | `dnf install curl git`    |
 | Pacman          | `pacman -S curl git`      |
@@ -243,7 +243,7 @@ Restart your shell so that `PATH` changes take effect. Opening a new terminal ta
 
 ## Core Installation Complete!
 
-This completes the installation of the `asdf` core  :tada:
+This completes the installation of the `asdf` core :tada:
 
 `asdf` is only useful once you install a **plugin**, install a **tool** and manage its **versions**. Continue the guide below to learn how to do this.
 

diff --git a/docs/manage/core.md b/docs/manage/core.md
@@ -68,11 +68,11 @@ nodejs 16.5.0
 
 `asdf` has a built in command to update which relies on Git (our recommended installation method). If you installed using a different method you should follow the steps for that method:
 
-| Method         | Latest Stable Release                                                                                                          | Latest commit on `master`  |
-| -------------- | ------------------------------------------------------------------------------------------------------------------------------ | -------------------------- |
-| asdf (via Git) | `asdf update`                                                                                                                  | `asdf update --head`       |
+| Method         | Latest Stable Release                                                                                                          | Latest commit on `master`        |
+| -------------- | ------------------------------------------------------------------------------------------------------------------------------ | -------------------------------- |
+| asdf (via Git) | `asdf update`                                                                                                                  | `asdf update --head`             |
 | Homebrew       | `brew upgrade asdf`                                                                                                            | `brew upgrade asdf --fetch-HEAD` |
-| Pacman         | Download a new `PKGBUILD` & rebuild <br/> or use your preferred [AUR helper](https://wiki.archlinux.org/index.php/AUR_helpers) |                            |
+| Pacman         | Download a new `PKGBUILD` & rebuild <br/> or use your preferred [AUR helper](https://wiki.archlinux.org/index.php/AUR_helpers) |                                  |
 
 ## Uninstall