docs: update 'zh-CN' to 'zh' (#17)

IDuxFE · Dec 13, 2020 · 9232ac7 · 9232ac7
1 parent e6db6ef
commit 9232ac7
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 15 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,12 +1,13 @@
 ## PR Checklist
+
 Please check if your PR fulfills the following requirements:
 
-- [ ] The commit message follows [our guidelines](https://github.com/IduxFE/components/blob/main/docs/contributing.zh-CN.md#commit)
+- [ ] The commit message follows [our guidelines](https://github.com/IduxFE/components/blob/main/docs/contributing.zh.md#commit)
 - [ ] Tests for the changes have been added/updated or not needed
 - [ ] Docs and demo have been added/updated or not needed
 
-
 ## PR Type
+
 What kind of change does this PR introduce?
 
 - [ ] Bugfix
@@ -20,13 +21,9 @@ What kind of change does this PR introduce?
 - [ ] Application (the showcase website) / infrastructure changes
 - [ ] Other... Please describe:
 
-
 ## What is the current behavior?
 <!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
 
-
 ## What is the new behavior?
 
-
 ## Other information
-
diff --git a/README.md b/README.md
@@ -54,7 +54,7 @@ npm run start
 
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/IduxFE/components/pulls)
 
-在任何形式的参与前，请先阅读 [贡献者文档](https://github.com/IduxFE/components/blob/main/docs/contributing.zh-CN.md)。如果你希望参与贡献，欢迎 [Pull Request](https://github.com/IduxFE/components/pulls)，或给我们 [报告 Bug](https://github.com/IduxFE/components/issues)。
+在任何形式的参与前，请先阅读 [贡献者文档](https://github.com/IduxFE/components/blob/main/docs/contributing.zh.md)。如果你希望参与贡献，欢迎 [Pull Request](https://github.com/IduxFE/components/pulls)，或给我们 [报告 Bug](https://github.com/IduxFE/components/issues)。
 
 > 强烈推荐阅读 [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way)、[《如何向开源社区提问题》](https://github.com/seajs/seajs/issues/545) 和 [《如何有效地报告 Bug》](http://www.chiark.greenend.org.uk/%7Esgtatham/bugs-cn.html)、[《如何向开源项目提交无法解答的问题》](https://zhuanlan.zhihu.com/p/25795393)，更好的问题更容易获得帮助。
 

diff --git a/docs/contributing.zh.md b/docs/contributing.zh.md
@@ -77,7 +77,7 @@ title: 贡献指南
 
 我们使用了 `eslint`, `stylelint`, `markdownlint` 以及 `ls-lint` 来保证整体的代码风格一致。并且在 commit hooks 中配置了自动格式化和 lint, 只要提交通过即可。
 
-## Commit 规范
+## Commit
 
 对于如何提交 git commit message，我们有非常精确的规则。我们希望所有的 commit message 更具可读性，这样在查看项目历史记录会变得容易，同时我们使用 commit message 生成 Changelog.
 

diff --git a/packages/components/button/demo/basic.md b/packages/components/button/demo/basic.md
@@ -1,18 +1,18 @@
 ---
 order: 0
 title:
-  zh-CN: 按钮类型
+  zh: 按钮类型
 ---
 
-## zh-CN
+## zh
 
 按钮有 5 种类型：主按钮、默认按钮、虚线按钮和链接按钮。
 
 ## demo
 
 ```html
 <template>
-  <ix-button mode="primary">Primary Button</ix-button>
+  <ix-button mode="primary" @click="console.log($event)">Primary Button</ix-button>
   <ix-button>Default Button</ix-button>
   <ix-button mode="dashed">Dashed Button</ix-button>
   <ix-button mode="text">Text Button</ix-button>

diff --git a/scripts/gen/index.ts b/scripts/gen/index.ts
@@ -68,7 +68,7 @@ if (moduleName === 'components') {
 }
 
 const docsZhTemplate = getDocsZhTemplate(upperFirstComponentName, moduleName)
-writeFileSync(`${dirname}/docs/index.zh-CN.md`, docsZhTemplate)
+writeFileSync(`${dirname}/docs/index.zh.md`, docsZhTemplate)
 
 const domeTemplate = getDomeTemplate(upperFirstComponentName, moduleName)
 writeFileSync(`${dirname}/demo/basic.md`, domeTemplate)
diff --git a/scripts/gen/template.ts b/scripts/gen/template.ts
@@ -124,13 +124,13 @@ export function getDomeTemplate(compName: string, moduleName: string): string {
   return `---
 order: 0
 title:
-  zh-CN: 基本
-  en-US: Basic
+  zh: 基本
+  en: Basic
 ---
 
 
 
-## zh-CN
+## zh