Browse Source

doc: update doc

pull/5223/head
tangjinzhou 3 years ago
parent
commit
95ce5f4eb1
  1. 9
      site/src/vueDocs/getting-started.en-US.md
  2. 11
      site/src/vueDocs/getting-started.zh-CN.md

9
site/src/vueDocs/getting-started.en-US.md

@ -46,9 +46,9 @@ import Antd from 'ant-design-vue';
import App from './App'; import App from './App';
import 'ant-design-vue/dist/antd.css'; import 'ant-design-vue/dist/antd.css';
const app = createApp(); const app = createApp(App);
app.use(Antd); app.use(Antd).mount('#app');
``` ```
The above imports Antd entirely. Note that CSS file needs to be imported separately. The above imports Antd entirely. Note that CSS file needs to be imported separately.
@ -104,9 +104,10 @@ And this plugin can load styles too, read [usage](https://github.com/ant-design/
> FYI, babel-plugin-import's `style` option will importing some global reset styles, don't use it if you don't need those styles. You can import styles manually via `import 'ant-design-vue/dist/antd.css'` and override the global reset styles. > FYI, babel-plugin-import's `style` option will importing some global reset styles, don't use it if you don't need those styles. You can import styles manually via `import 'ant-design-vue/dist/antd.css'` and override the global reset styles.
If you use Vite, you can use [unplugin-vue-components](https://github.com/antfu/unplugin-vue-components) to load on demand. However, this plugin can only deal with components. Others such as message should be loaded manually: If you use Vite, you can use [unplugin-vue-components](https://github.com/antfu/unplugin-vue-components) to load on demand. However, this plugin can only deal with components. Others such as message should be loaded manually:
```ts ```ts
import { message } from "ant-design-vue" import { message } from 'ant-design-vue';
import "ant-design-vue/es/message/style/css" //use ant-design-vue/es instead of ant-design-vue/lib import 'ant-design-vue/es/message/style/css'; //use ant-design-vue/es instead of ant-design-vue/lib
``` ```
## Customization ## Customization

11
site/src/vueDocs/getting-started.zh-CN.md

@ -48,9 +48,9 @@ import Antd from 'ant-design-vue';
import App from './App'; import App from './App';
import 'ant-design-vue/dist/antd.css'; import 'ant-design-vue/dist/antd.css';
const app = createApp(); const app = createApp(App);
app.use(Antd); app.use(Antd).mount('#app');
``` ```
以上代码便完成了 Antd 的引入。需要注意的是,样式文件需要单独引入。 以上代码便完成了 Antd 的引入。需要注意的是,样式文件需要单独引入。
@ -74,7 +74,7 @@ app.config.globalProperties.$message = message;
## 兼容性 ## 兼容性
Ant Design Vue 2.x 支持所有的现代浏览器。 Ant Design Vue 2.x+ 支持所有的现代浏览器。
如果需要支持 IE9+,你可以使用 Ant Design Vue 1.x & Vue 2.x。 如果需要支持 IE9+,你可以使用 Ant Design Vue 1.x & Vue 2.x。
@ -104,9 +104,10 @@ import { Button } from 'ant-design-vue';
> 注意,babel-plugin-import 的 `style` 属性除了引入对应组件的样式,也会引入一些必要的全局样式。如果你不需要它们,建议不要使用此属性。你可以 `import 'ant-design-vue/dist/antd.css` 手动引入,并覆盖全局样式。 > 注意,babel-plugin-import 的 `style` 属性除了引入对应组件的样式,也会引入一些必要的全局样式。如果你不需要它们,建议不要使用此属性。你可以 `import 'ant-design-vue/dist/antd.css` 手动引入,并覆盖全局样式。
如果你使用的 Vite,你可以使用 [unplugin-vue-components](https://github.com/antfu/unplugin-vue-components) 来进行按需加载。但是此插件无法处理非组件模块,如 message,这种组件需要手动加载: 如果你使用的 Vite,你可以使用 [unplugin-vue-components](https://github.com/antfu/unplugin-vue-components) 来进行按需加载。但是此插件无法处理非组件模块,如 message,这种组件需要手动加载:
```ts ```ts
import { message } from "ant-design-vue" import { message } from 'ant-design-vue';
import "ant-design-vue/es/message/style/css" //vite只能用 ant-design-vue/es 而非 ant-design-vue/lib import 'ant-design-vue/es/message/style/css'; //vite只能用 ant-design-vue/es 而非 ant-design-vue/lib
``` ```
## 配置主题和字体 ## 配置主题和字体

Loading…
Cancel
Save