From 46b4cd5d439776ba6402f9c34f5a71da94c6ac35 Mon Sep 17 00:00:00 2001 From: tangjinzhou <415800467@qq.com> Date: Mon, 4 Jun 2018 18:36:46 +0800 Subject: [PATCH] docs: update customize-theme --- docs/vue/customize-theme.en-US.md | 10 +++++++++- docs/vue/customize-theme.zh-CN.md | 11 ++++++++++- 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/docs/vue/customize-theme.en-US.md b/docs/vue/customize-theme.en-US.md index 2141f3407..e1f0dc370 100644 --- a/docs/vue/customize-theme.en-US.md +++ b/docs/vue/customize-theme.en-US.md @@ -28,6 +28,14 @@ Specify the `theme` property in the `package.json` or `.webpackrc` file, whose v "primary-color": "#1DA57A", }, ``` +you can write a webpack config about [less-loader modifyVars](https://github.com/webpack/less-loader#less-options) like [atool-build](https://github.com/ant-tool/atool-build/blob/a4b3e3eec4ffc09b0e2352d7f9d279c4c28fdb99/src/getWebpackCommonConfig.js#L131-L138) does. + +Note: + +- Importing styles from less files is necessary. + - If you import styles by specifying the `style` option of [babel-plugin-import](https://github.com/ant-design/babel-plugin-import), change it from `'css'` to `true`, which will import the `less` version of antd. + - If you import styles from `'vue-antd-ui/dist/antd.css'`, change it to `vue-antd-ui/dist/antd.less`. +- If you want to override `@icon-url`, the value must be contained in quotes like `"@icon-url": "'your-icon-font-path'"`. ### 2) Overriding Less variables (alternative way) @@ -35,7 +43,7 @@ Override variables via less definition files. Create a standalone less file like the one below, and import it in your project. - ```css + ```less @import "~vue-antd-ui/dist/antd.less"; // import official less entry file @import "your-theme-file.less"; // override variables here ``` diff --git a/docs/vue/customize-theme.zh-CN.md b/docs/vue/customize-theme.zh-CN.md index 5bf8ff0c9..0652c0833 100644 --- a/docs/vue/customize-theme.zh-CN.md +++ b/docs/vue/customize-theme.zh-CN.md @@ -30,6 +30,15 @@ antd 的样式使用了 [Less](http://lesscss.org/) 作为开发语言,并定 "primary-color": "#1DA57A", }, ``` +定义 `theme` 属性时,需要配合使用`less-loader` 的 `modifyVars` 配置来覆盖原来的样式变量。 +可以参考 [atool-build 中 less-loader 的 webpack 相关配置](https://github.com/ant-tool/atool-build/blob/a4b3e3eec4ffc09b0e2352d7f9d279c4c28fdb99/src/getWebpackCommonConfig.js#L131-L138) + +注意: + +- 样式必须加载 less 格式。 + - 如果你在使用 [babel-plugin-import](https://github.com/ant-design/babel-plugin-import) 的 `style` 配置来引入样式,需要将配置值从 `'css'` 改为 `true`,这样会引入 less 文件。 + - 如果你是通过 `'vue-antd-ui/dist/antd.css'` 引入样式的,改为 `vue-antd-ui/dist/antd.less`。 +- 如果要覆盖 `@icon-url` 变量,内容需要包括引号 `"@icon-url": "'your-icon-font-path'"`。 ### 2) less @@ -37,7 +46,7 @@ antd 的样式使用了 [Less](http://lesscss.org/) 作为开发语言,并定 建立一个单独的 `less` 文件如下,再引入这个文件。 - ```css + ```less @import "~vue-antd-ui/dist/antd.less"; // 引入官方提供的 less 样式入口文件 @import "your-theme-file.less"; // 用于覆盖上面定义的变量 ```