<commit_before># Vue-Awesome

> 基于 Vue.js 的强大 SVG 图标组件。已内置 Font Awesome 图标。

Vue-Awesome 基于 [Font Awesome](https://github.com/FortAwesome/Font-Awesome) `v4.5.0` 构建，依赖 [Vue.js](https://vuejs.org/) `v2.0.1`+。

查看[此处](https://justineo.github.io/vue-awesome/demo/)的 demo 一睹为快。

## 安装

### npm（推荐方式）

```bash
$ npm install vue-awesome
```

### bower

```bash
$ bower install vue-awesome
```

### 手动安装

直接下载 `dist/vue-awesome.js` 并在 HTML 文件中引入：

```html
<script src="path/to/vue-awesome/dist/vue-awesome.js"></script>
```

## 使用方法

```html
<!-- 基础用法 -->
<icon name="beer"></icon>

<!-- 添加选项 -->
<icon name="refresh" scale="2" spin></icon>
<icon name="comment" flip="horizontal"></icon>
<icon name="code-fork" label="Forked Repository"></icon>

<!-- 堆叠图标 -->
<icon label="No Photos">
  <icon name="camera"></icon>
  <icon name="ban" scale="2" class="alert"></icon>
</icon>
```

### 用 npm 与 vue-loader 基于 ES Module 引入（推荐用法）

```js
import Vue from 'vue'

/* 在下面两种方式中任选一种 */

// 仅引入用到的图标以减小打包体积
import 'vue-awesome/icons/flag'

// 或者在不关心打包体积时一次引入全部图标
import 'vue-awesome/icons'

/* 任选一种注册组件的方式 */

import Icon from 'vue-awesome/components/Icon'

// 全局注册（在 `main .js` 文件中）
Vue.component('icon', Icon)

// 或局部注册（在组件文件中）
export default {
  components: {
    Icon
  }
}
```

#### ⚠️ 注意事项

##### 引入源码版本

如果你正在使用 vue-cli 来创建项目并且希望使用未经转译的组件（引入 `vue-echarts/components/Icon` 而非直接引入 `vue-awesome`）来减小打包尺寸（是推荐用法），那么 Vue 的 `webpack` 模板可能会把 `node_modules` 中的文件排除在 Babel 转译范围以外。要解决此问题，需要按下述的方式修改 `build/webpack.base.conf.js`：

对于 webpack 1.x：

```diff
      {
        test: /\.js$/,
        loader: 'babel',
        include: [
-          path.join(projectRoot, 'src')
+          path.join(projectRoot, 'src'),
+          path.join(projectRoot, 'node_modules/vue-awesome')
        ],
-        exclude: /node_modules/
+        exclude: /node_modules(?![\\/]vue-awesome[\\/])/
      },
```
<commit_msg>Update README.zh_CN.md<commit_after># Vue-Awesome

> 基于 Vue.js 的强大 SVG 图标组件。已内置 Font Awesome 图标。

Vue-Awesome 基于 [Font Awesome](https://github.com/FortAwesome/Font-Awesome) `v4.5.0` 构建，依赖 [Vue.js](https://vuejs.org/) `v2.0.1`+。

查看[此处](https://justineo.github.io/vue-awesome/demo/)的 demo 一睹为快。

## 安装

### npm（推荐方式）

```bash
$ npm install vue-awesome
```

### bower

```bash
$ bower install vue-awesome
```

### 手动安装

直接下载 `dist/vue-awesome.js` 并在 HTML 文件中引入：

```html
<script src="path/to/vue-awesome/dist/vue-awesome.js"></script>
```

## 使用方法

```html
<!-- 基础用法 -->
<icon name="beer"></icon>

<!-- 添加选项 -->
<icon name="refresh" scale="2" spin></icon>
<icon name="comment" flip="horizontal"></icon>
<icon name="code-fork" label="Forked Repository"></icon>

<!-- 堆叠图标 -->
<icon label="No Photos">
  <icon name="camera"></icon>
  <icon name="ban" scale="2" class="alert"></icon>
</icon>
```

### 用 npm 与 vue-loader 基于 ES Module 引入（推荐用法）

```js
import Vue from 'vue'

/* 在下面两种方式中任选一种 */

// 仅引入用到的图标以减小打包体积
import 'vue-awesome/icons/flag'

// 或者在不关心打包体积时一次引入全部图标
import 'vue-awesome/icons'

/* 任选一种注册组件的方式 */

import Icon from 'vue-awesome/components/Icon'

// 全局注册（在 `main .js` 文件中）
Vue.component('icon', Icon)

// 或局部注册（在组件文件中）
export default {
  components: {
    Icon
  }
}
```

#### ⚠️ 注意事项

##### 引入源码版本

如果你正在使用 vue-cli 来创建项目并且希望使用未经转译的组件（引入 `vue-awesome/components/Icon` 而非直接引入 `vue-awesome`）来减小打包尺寸（是推荐用法），那么 Vue 的 `webpack` 模板可能会把 `node_modules` 中的文件排除在 Babel 转译范围以外。要解决此问题，需要按下述的方式修改 `build/webpack.base.conf.js`：

对于 webpack 1.x：

```diff
      {
        test: /\.js$/,
        loader: 'babel',
        include: [
-          path.join(projectRoot, 'src')
+          path.join(projectRoot, 'src'),
+          path.join(projectRoot, 'node_modules/vue-awesome')
        ],
-        exclude: /node_modules/
+        exclude: /node_modules(?![\\/]vue-awesome[\\/])/
      },
```

{'fraction_non_alphanumeric': 0.20579633076309492, 'fraction_numerical': 0.004785961180537091, 'mean_word_length': 3.3948598130841123, 'pattern_counts': {'":': 0, '<': 41, '<?xml version=': 0, '>': 43, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '455448', 'n_tokens_mistral': 1887, 'n_tokens_neox': 1934, 'n_words': 285}