https://github.com/ntnyq/vuepress-plugin-iconify

:hatching_chick: Using icons more easier in VuePress
https://github.com/ntnyq/vuepress-plugin-iconify

icon iconify svg-icon vuepress vuepress-plugin vuepress2 vuepress2-plugin

Last synced: 6 months ago
JSON representation

:hatching_chick: Using icons more easier in VuePress

• Host: GitHub
• URL: https://github.com/ntnyq/vuepress-plugin-iconify
• Owner: ntnyq
• License: mit
• Created: 2022-05-03T02:32:42.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-04-21T06:34:18.000Z (6 months ago)
• Last Synced: 2025-04-21T07:42:35.924Z (6 months ago)
• Topics: icon, iconify, svg-icon, vuepress, vuepress-plugin, vuepress2, vuepress2-plugin
• Language: TypeScript
• Homepage: https://vuepress-plugin-iconify.ntnyq.com/
• Size: 938 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# vuepress-plugin-iconify

[![CI](https://github.com/ntnyq/vuepress-plugin-iconify/workflows/CI/badge.svg)](https://github.com/ntnyq/vuepress-plugin-iconify/actions)

[![NPM VERSION](https://img.shields.io/npm/v/vuepress-plugin-iconify.svg)](https://www.npmjs.com/package/vuepress-plugin-iconify)

[![NPM DOWNLOADS](https://img.shields.io/npm/dy/vuepress-plugin-iconify.svg)](https://www.npmjs.com/package/vuepress-plugin-iconify)

[![LICENSE](https://img.shields.io/github/license/ntnyq/vuepress-plugin-iconify.svg)](https://github.com/ntnyq/vuepress-plugin-iconify/blob/main/LICENSE)

**vuepress-plugin-iconify** is a plugin for [VuePress](https://v2.vuepress.vuejs.org) that adds icons to your documentation.

:book: [Live Demo and Docs](https://vuepress-plugin-iconify.ntnyq.com)

## Install

```shell

npm install vuepress-plugin-iconify -D

```

```shell

yarn add vuepress-plugin-iconify -D

```

```shell

pnpm add vuepress-plugin-iconify -D

```

## Usage

> See [Official Docs](https://v2.vuepress.vuejs.org/guide/plugin.html#plugin) about how to use a plugin in VuePress.

```ts

import { defineUserConfig } from 'vuepress'

import { iconifyPlugin } from 'vuepress-plugin-iconify'

export default defineUserConfig({

  plugins: [iconifyPlugin()],

})

```

Then, you can use the `VpIcon` component in your docs:

```html

```

## Prior Art

- [iconify](https://iconify.design)

## License

[MIT](./LICENSE) © [@ntnyq](https://github.com/ntnyq)