Skip to content

Commit

Permalink
chore: updater i18n guide
Browse files Browse the repository at this point in the history
  • Loading branch information
patricklai3 committed Jul 22, 2023
1 parent f3da0a0 commit 5933011
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 10 deletions.
18 changes: 10 additions & 8 deletions .github/trans-guide-no-exp-en.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# Docs Translation GuideNo Experience
# Docs Translation Guide (No Experience)

## Software Needed

This site uses [Vitepress](https://vitepress.dev/), you can refer to their website for more information.

- [Node.js](https://nodejs.org/en/download)(JavaScript runtime environment)
- [Visual Studio Code](https://code.visualstudio.com/)(Editor)
- [Git](https://marketplace.visualstudio.com/items?itemName=antfu.vite)(Source Management)
- [Vite Extension](https://marketplace.visualstudio.com/items?itemName=antfu.vite)(Offical VSCode Extension)
- [Node.js](https://nodejs.org/en/download) (JavaScript runtime environment)
- [pnpm](https://pnpm.io/) (Package Manager)
- [Visual Studio Code](https://code.visualstudio.com/) (Source Editor)
- [Git](https://marketplace.visualstudio.com/items?itemName=antfu.vite) (Source Management)
- [Vite Extension](https://marketplace.visualstudio.com/items?itemName=antfu.vite) (Offical VSCode Extension)
- [Markdown All in One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one) (Markdown Toolkit Extension)
- [Iconify IntelliSense](#)

## Tool Prep

Expand Down Expand Up @@ -94,7 +96,7 @@ git config --global user.email "youremail"

![](/src/public/imgs/i18n-guide/11.png)

2. Once the installation completes, the Vite extension will automatically start a local test server at `http://localhost:4000`, and open a build-in browser, you can also use your own browser by visiting the address thereyou may encounter problems right after installation, relaunch to VSCode if error occurs
2. Once the installation completes, the Vite extension will automatically start a local test server at `http://localhost:4000`, and open a build-in browser, you can also use your own browser by visiting the address there(you may encounter problems right after installation, relaunch to VSCode if error occurs)

![](/src/public/imgs/i18n-guide/12.png)

Expand All @@ -106,13 +108,13 @@ git config --global user.email "youremail"

## Translation Items

The following content that requires translation is listed in the order they appear in the file explorer (alphabetically),"\*\*" refers to the language code of a certain languagee.g. ja-Japanese,fr-French
The following content that requires translation is listed in the order they appear in the file explorer (alphabetically),"\*\*" refers to the language code of a certain language(e.g. ja-Japanese,fr-French)

- `\.vitepress\config\**.ts` Configuration of its respective language, affects all pages' format in that language

![](/src/public/imgs/i18n-guide/13.png)

- `\src\**\manual` All content requires translation, you need to configure each page's "frontmatter"second picture below, which affects that specific page's format
- `\src\**\manual` All content requires translation, you need to configure each page's "frontmatter"(second picture below), which affects that specific page's format

![](/src/public/imgs/i18n-guide/14.png)

Expand Down
11 changes: 9 additions & 2 deletions .github/trans-guide-no-exp.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
使用架构为[Vitepress](https://vitepress.dev/),有疑惑可以访问他们的网站检索说明书。

- [Node.js](https://nodejs.org/en/download)(网站运行环境)
- [pnpm](https://pnpm.io/)(包管理器)
- [Visual Studio Code](https://code.visualstudio.com/)(内容编辑器)
- [Git](https://marketplace.visualstudio.com/items?itemName=antfu.vite)(资源管理)
- [Vite 插件](https://marketplace.visualstudio.com/items?itemName=antfu.vite)(网站架构官方辅助插件)
Expand Down Expand Up @@ -37,11 +38,17 @@

![](/src/public/imgs/i18n-guide/25.png)

7. 在底部打开的窗口中点击右上“+”菜单,并选择“Git Bash”
7. 在命令行内输入以下指令以安装 pnpm

```
iwr https://get.pnpm.io/install.ps1 -useb | iex
```

8. 在底部打开的窗口中点击右上“+”菜单,并选择“Git Bash”

![](/src/public/imgs/i18n-guide/26.png)

8. 在命令行内分别输入以下指令,将昵称和邮件地址替换为你的信息,并回车
9. 在命令行内分别输入以下指令,将昵称和邮件地址替换为你的信息,并回车

```
git config --global user.name "你的昵称"
Expand Down

0 comments on commit 5933011

Please sign in to comment.