vuepress-plugin-svg-icons

❤️ SVG sprite plugin for VuePress

📖 Live Demo and Docs

Note

⚠️ Main branch since v5 is for VuePress v2

Check vuepress-v1 for VuePress v1 support.

Install

$ npm install @goy/vuepress-plugin-svg-icons -D
# OR
$ yarn add @goy/vuepress-plugin-svg-icons -D

Usage

import { defineUserConfig } from '@vuepress/cli'
import { svgIconPlugin } from '@goy/vuepress-plugin-svg-icons'

export default defineUserConfig({
  plugins: [svgIconPlugin()],
})

Create a folder named icons in your document sourceDir and put all your svg files in it.

All icons will be loaded automatic.

The plugin provides a global component named vp-icon.

Just enjoy it!

<vp-icon name="github" />

<vp-icon color="#3eaf7c" name="vue" />

<vp-icon color="#3eaf7c" name="vue" size="4em"/>

Custom options detail