1.0.5 • Published 3 years ago

@wetutils/vue-iconfont-cli v1.0.5

Weekly downloads
-
License
MIT
Repository
-
Last release
3 years ago

vue-iconfont

介绍

一个可以从iconfont网站图标生成vue组件的命令行工具,也支持本地svg文件生成vue组件

使用

1.安装
yarn add @wetutils/vue-iconfont-cli

npm install @wetutils/vue-iconfont-cli
2. 生成配置文件
npx vue-iconfont init

此时项目根目录会生成一个iconfont.json的文件,内容如下:

{
    "income": "./src/svg",
    "output": "./src/iconfont",
    "mode": "all-in-one",
    "prefix": "icon",
    "size": 18
}

配置参数说明:

  1. income,请直接复制iconfont官网提供的项目链接。请务必看清是.js后缀而不是.css后缀,也可以指明项目本地存放svg文件的路径

  2. output,

  3. mode 组件方式,目前只支持all-in-one,也就是一个svg生成一个vue组件,后期会考虑扩展
  4. output 根据iconfont图标生成的组件存放的位置。每次生成组件之前,该文件夹都会被清空
  5. prefix 默认前缀,目前没有什么用
  6. size 默认生成组件的字体大小

配置示例:

{
    "income": "./src/svg",
    "output": "./src/iconfont",
    "mode": "all-in-one",
    "prefix": "icon",
    "size": 18
}
3. 开始生成Vue模板组件
npx vue-iconfont create

特技

  1. 使用 Readme_XXX.md 来支持不同的语言,例如 Readme_en.md, Readme_zh.md
  2. Gitee 官方博客 blog.gitee.com
  3. 你可以 https://gitee.com/explore 这个地址来了解 Gitee 上的优秀开源项目
  4. GVP 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目
  5. Gitee 官方提供的使用手册 https://gitee.com/help
  6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 https://gitee.com/gitee-stars/