vitepress-icons

A TypeScript library that offers a comprehensive collection of social media SVG icons, specifically designed for seamless integration with VitePress. Easily incorporate these icons into your VitePress documentation with type safety and consistency.

Features

• TypeScript Support: Fully typed icons for seamless integration.
• SVG Icons: High-quality SVGs for various social media platforms.
• VitePress Optimized: Tailored for easy use within VitePress projects.
• Easy to Use: Simple import and usage within your VitePress components.

Installation

Install the library using npm or yarn:

npm install vitepress-icons

yarn add vitepress-icons

Usage

In .vitepress/config.ts:

import { defineConfig } from 'vitepress'
import { socialMediaIcons } from 'vitepress-icons'

export default defineConfig({
    ...
    themeConfig: {
        socialLinks: [
            { icon: socialMediaIcons.github, link: 'https://github.com/marat2509/vitepress-icons' },
            { icon: socialMediaIcons.twitter, link: '...' },
            { icon: socialMediaIcons.telegram, link: '...' },
        ],
    }
    ...
})

Contributing

Contributions are welcome! Please open an issue or submit a pull request