README.md

Socialize

Elegant social media badges to spice up your markdown at your disposal.

Usage

Getting an icon in markdown:

![twitter](https://socialize-md.vercel.app/api/badge/twitter)

Linking social to icon in markdown:

[![twitter](https://socialize-md.vercel.app/api/badge/twitter)](https://twitter.com/your_handle)

Adding a new badge

To add a new icon you must follow a couple of steps:

  1. Fork this repo and create a new branch.
  2. Add your icon template to the /assets/server/icons directory.
    • In order to properly align icon create a 20x20 pixel box and align 10-12px wide icon in the center both vertically and horizontally.
    • Icons must be between 10-12 pixels.
    • Icons must be white (#fff).
    • Strip all properties except for path.
  3. Import and add your icon to the i object in /assets/server/icons/index.ts.
  4. Navigate to pages/api/badge/[ico].ts and add your icon to the switch statement with the desired background color.
  5. Create a pull request and wait for review!

All current icons

NameIcon
Discord (discord)discord
Dribbble (dribbble)dribbble
Facebook (facebook)facebook
Github (github)github
Instagram (instagram)instagram
Linkedin (linkedin)linkedin
Mail (mail)mail
Opensea (opensea)opensea
Reddit (reddit)reddit
Snapchat (snapchat)snapchat
Spotify (spotify)spotify
Stack Overflow (stackoverflow)stack overflow
Steam (steam)steam
Tiktok (tiktok)tiktok
Twitch (twitch)twitch
Twitter (twitter)twitter
Web (web)web
Youtube (youtube)youtube

Like this project? Support me with ethereum: 0xD4c6325E42fac0625B25C0d4DB40823870986609