style: 优化格式更新文档

FightingDesign · May 6, 2024 · bccea52 · bccea52
1 parent 056b00b
commit bccea52
Show file tree

Hide file tree

Showing 49 changed files with 304 additions and 658 deletions.
diff --git a/CONTRIBUTING.en-US.md b/CONTRIBUTING.en-US.md
@@ -1,5 +1,9 @@
 # CONTRIBUTING
 
+> 暂未翻译。
+>
+> Not yet translated.
+
 English | [Chinese](https://github.com/FightingDesign/fighting-design/blob/master/CONTRIBUTING.md)
 
 ## 👋 写在前面
@@ -52,8 +56,7 @@ pnpm dev:docs
 
 编辑器强烈推荐使用 [Visual Studio Code](https://code.visualstudio.com/)，内置插件请务必安装以下几款：
 
-- [Vue Language Features (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.volar) Vue3 官方开发插件
-- [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) 用于支持在 TS 中 import `*.vue` 文件
+- [Vue - Official](https://marketplace.visualstudio.com/items?itemName=Vue.volar) Vue3 官方开发插件
 - [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) 代码格式校验，如果不安装，那么 [fighting-eslint-config](https://github.com/FightingDesign/fighting-design/blob/master/packages/fighting-eslint-config) 则不生效
 - [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) 用于检测单词拼写错误
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,6 +1,6 @@
-# CONTRIBUTING
+# 贡献指南
 
-English | [Chinese](https://github.com/FightingDesign/fighting-design/blob/master/CONTRIBUTING.md)
+[English](https://github.com/FightingDesign/fighting-design/blob/master/CONTRIBUTING.en-US.md) | Chinese
 
 ## 👋 写在前面
 
@@ -52,8 +52,7 @@ pnpm dev:docs
 
 编辑器强烈推荐使用 [Visual Studio Code](https://code.visualstudio.com/)，内置插件请务必安装以下几款：
 
-- [Vue Language Features (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.volar) Vue3 官方开发插件
-- [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) 用于支持在 TS 中 import `*.vue` 文件
+- [Vue - Official](https://marketplace.visualstudio.com/items?itemName=Vue.volar) Vue3 官方开发插件
 - [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) 代码格式校验，如果不安装，那么 [fighting-eslint-config](https://github.com/FightingDesign/fighting-design/blob/master/packages/fighting-eslint-config) 则不生效
 - [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) 用于检测单词拼写错误
 

diff --git a/README.md b/README.md
@@ -35,7 +35,6 @@
 - 👍 Maintained by the community team
 - ❤️ Developed according to actual demand
 - 📃 High quality detailed documentation
-- 📌 Improve RFC
 - ☝️ Put forward demands and keep improving
 - 🌍 More configuration options & flexible components
 - 🛠 More features are under development
@@ -71,7 +70,9 @@ import App from './App.vue'
 import FightingDesign from 'fighting-design'
 import 'fighting-design/dist/index.css'
 
-createApp(App).use(FightingDesign).mount('#app')
+const app = createApp(App)
+app.use(FightingDesign)
+app.mount('#app')
 ```
 
 ## 🪂 Quick experience
@@ -132,7 +133,7 @@ createApp(App).use(FightingDesign).mount('#app')
 
 Add WeChat & please note the `Github` username
 
-<img width="200" height="200" src="https://raw.githubusercontent.com/Tyh2001/images/master/my/we-chat.jpg" >
+<img width="200" height="200" src="https://raw.githubusercontent.com/Tyh2001/images/master/my/we-chat-2.jpg" >
 
 ## 💌 Special Thanks
 

diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -36,7 +36,6 @@
 - 👍 社区团队维护
 - ❤️ 根据实际需求开发
 - 📃 优质详细的文档
-- 📌 完善 RFC
 - ☝️ 提出需求，不断完善
 - 🌍 更多配置项，灵活组件
 - 🛠 更多特性开发中
@@ -68,10 +67,13 @@ yarn add --save-dev fighting-design
 ```ts
 import { createApp } from 'vue'
 import App from './App.vue'
+
 import FightingDesign from 'fighting-design'
 import 'fighting-design/dist/index.css'
 
-createApp(App).use(FightingDesign).mount('#app')
+const app = createApp(App)
+app.use(FightingDesign)
+app.mount('#app')
 ```
 
 ## 🪂 快速体验
@@ -132,7 +134,7 @@ createApp(App).use(FightingDesign).mount('#app')
 
 添加微信请备注 `Github` 用户名
 
-<img width="200" height="200" src="https://raw.githubusercontent.com/Tyh2001/images/master/my/we-chat.jpg" >
+<img width="200" height="200" src="https://raw.githubusercontent.com/Tyh2001/images/master/my/we-chat-2.jpg" >
 
 ## 💌 特别感谢
 

diff --git a/docs/components/date-picker.md b/docs/components/date-picker.md
@@ -5,10 +5,6 @@
 - [源代码](https://github.com/FightingDesign/fighting-design/tree/master/packages/fighting-design/date-picker)
 - [文档编辑](https://github.com/FightingDesign/fighting-design/blob/master/docs/components/date-picker.md)
 
-:::danger
-组件仍在测试阶段，高频更新中，部分参数暂不稳定！
-:::
-
 ## 基本使用
 
 使用 `v-model:date` 绑定一个值

diff --git a/docs/components/input-number.md b/docs/components/input-number.md
@@ -5,10 +5,6 @@
 - [源代码](https://github.com/FightingDesign/fighting-design/tree/master/packages/fighting-design/input-number)
 - [文档编辑](https://github.com/FightingDesign/fighting-design/blob/master/docs/components/input-number.md)
 
-:::danger
-组件仍在测试阶段，高频更新中，部分参数暂不稳定！
-:::
-
 ## 基本使用
 
 使用 `v-model` 绑定一个值，`model` 可配置不同的模式

diff --git a/docs/components/loading.md b/docs/components/loading.md
@@ -5,10 +5,6 @@
 - [源代码](https://github.com/FightingDesign/fighting-design/tree/master/packages/fighting-design/loading)
 - [文档编辑](https://github.com/FightingDesign/fighting-design/blob/master/docs/components/loading.md)
 
-:::danger
-组件仍在测试阶段，高频更新中，部分参数暂不稳定！
-:::
-
 ## 基本使用
 
 可以在指定元素上通过`fighting-design`内置指令 `v-loading` 来实现加载状态

diff --git a/docs/components/menu.md b/docs/components/menu.md
@@ -5,10 +5,6 @@
 - [源代码](https://github.com/FightingDesign/fighting-design/tree/master/packages/fighting-design/menu)
 - [文档编辑](https://github.com/FightingDesign/fighting-design/blob/master/docs/components/menu.md)
 
-:::danger
-组件仍在测试阶段，高频更新中，部分参数暂不稳定！
-:::
-
 ## 基本使用
 
 ::: demo

diff --git a/docs/components/notification.md b/docs/components/notification.md
@@ -244,7 +244,7 @@
 | `background` | 自定义背景色                                 | string                                                                                       | ——                                                  | ——        |
 | `placement`  | 弹出位置                                     | <a href="#notificationplacement">NotificationPlacement</a>                                   | `top-left` `top-right` `bottom-left` `bottom-right` | top-right |
 | `offset`     | 偏移距离                                     | number                                                                                       | ——                                                  | 20        |
-| `close-btn`  | 自定义关闭按钮                               | string / <a href="/components/interface.html#fightingicon">FightingIcon</a> | ——                                                  | ——        |
+| `close-btn`  | 自定义关闭按钮                               | string / <a href="/components/interface.html#fightingicon">FightingIcon</a>                  | ——                                                  | ——        |
 | `z-index`    | 层级                                         | boolean                                                                                      | ——                                                  | 1000      |
 | `on-close`   | 关闭之后回调                                 | <a href="/components/message.html#messageclose">MessageClose</a>                             | ——                                                  | ——        |
 

diff --git a/docs/components/pagination.md b/docs/components/pagination.md
@@ -5,10 +5,6 @@
 - [源代码](https://github.com/FightingDesign/fighting-design/tree/master/packages/fighting-design/pagination)
 - [文档编辑](https://github.com/FightingDesign/fighting-design/blob/master/docs/components/pagination.md)
 
-:::danger
-组件仍在测试阶段，高频更新中，部分参数暂不稳定！
-:::
-
 ## 基本使用
 
 `v-model:current` 属性来绑定当前页码

diff --git a/docs/components/slider.md b/docs/components/slider.md
@@ -5,10 +5,6 @@
 - [源代码](https://github.com/FightingDesign/fighting-design/tree/master/packages/fighting-design/slider)
 - [文档编辑](https://github.com/FightingDesign/fighting-design/blob/master/docs/components/slider.md)
 
-:::danger
-组件仍在测试阶段，高频更新中，部分参数暂不稳定！
-:::
-
 ## 基本使用
 
 使用 `v-model` 绑定一个数字

diff --git a/docs/components/table.md b/docs/components/table.md
@@ -5,10 +5,6 @@
 - [源代码](https://github.com/FightingDesign/fighting-design/tree/master/packages/fighting-design/table)
 - [文档编辑](https://github.com/FightingDesign/fighting-design/blob/master/docs/components/table.md)
 
-:::danger
-组件仍在测试阶段，高频更新中，部分参数暂不稳定！
-:::
-
 ## 基本使用
 
 `data` 属性绑定需要展示的数据

diff --git a/docs/components/time-picker.md b/docs/components/time-picker.md
@@ -5,10 +5,6 @@
 - [源代码](https://github.com/FightingDesign/fighting-design/tree/master/packages/fighting-design/time-picker)
 - [文档编辑](https://github.com/FightingDesign/fighting-design/blob/master/docs/components/time-picker.md)
 
-:::danger
-组件仍在测试阶段，高频更新中，部分参数暂不稳定！
-:::
-
 ## 基本使用
 
 使用 `v-model:time` 绑定一个值