mirror of
https://github.com/pengzhanbo/vuepress-theme-plume.git
synced 2026-04-23 10:58:13 +08:00
41 lines
613 B
Markdown
41 lines
613 B
Markdown
# `@vuepress-plume/plugin-iconify`
|
|
|
|
添加 `iconify` 图标库支持。并注入全局组件 `<Iconify>`
|
|
|
|
## Install
|
|
```
|
|
yarn add @vuepress-plume/plugin-iconify
|
|
```
|
|
## Usage
|
|
``` js
|
|
// .vuepress/config.js
|
|
const iconifyPlugin = require('@vuepress-plume/plugin-iconify')
|
|
module.exports = {
|
|
//...
|
|
plugins: [
|
|
iconifyPlugin()
|
|
]
|
|
// ...
|
|
}
|
|
```
|
|
|
|
## Options
|
|
|
|
```ts
|
|
interface IconifyOptions {
|
|
/**
|
|
* 组件名， 默认 `Iconify`
|
|
*/
|
|
componentName?: string
|
|
color?: string
|
|
size?: string | number
|
|
}
|
|
|
|
```
|
|
|
|
## Component
|
|
|
|
```vue
|
|
<Iconify name="material-symbols:home" color="currentColor" size="1em" />
|
|
```
|