https://github.com/paul-bokelman/socialize

Elegant social media badges to spice up your markdown at your disposal.
https://github.com/paul-bokelman/socialize

api elegant github icons markdown nice-markdown simple social social-icons

Last synced: 11 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/paul-bokelman/socialize
• Owner: paul-bokelman
• Created: 2021-11-08T19:06:40.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-01-12T18:13:37.000Z (over 4 years ago)
• Last Synced: 2025-06-25T20:02:59.421Z (11 months ago)
• Topics: api, elegant, github, icons, markdown, nice-markdown, simple, social, social-icons
• Language: TypeScript
• Homepage: https://socialize-md.vercel.app/
• Size: 228 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
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 svg 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


| Name                             | Icon                                                                       |

| -------------------------------- | -------------------------------------------------------------------------- |

| Discord (`discord`)              | ![discord](https://socialize-md.vercel.app/api/badge/discord)              |

| Dribbble (`dribbble`)            | ![dribbble](https://socialize-md.vercel.app/api/badge/dribbble)            |

| Facebook (`facebook`)            | ![facebook](https://socialize-md.vercel.app/api/badge/facebook)            |

| Github (`github`)                | ![github](https://socialize-md.vercel.app/api/badge/github)                |

| Instagram (`instagram`)          | ![instagram](https://socialize-md.vercel.app/api/badge/instagram)          |

| Linkedin (`linkedin`)            | ![linkedin](https://socialize-md.vercel.app/api/badge/linkedin)            |

| Mail (`mail`)                    | ![mail](https://socialize-md.vercel.app/api/badge/mail)                    |

| Opensea (`opensea`)              | ![opensea](https://socialize-md.vercel.app/api/badge/opensea)              |

| Reddit (`reddit`)                | ![reddit](https://socialize-md.vercel.app/api/badge/reddit)                |

| Snapchat (`snapchat`)            | ![snapchat](https://socialize-md.vercel.app/api/badge/snapchat)            |

| Spotify (`spotify`)              | ![spotify](https://socialize-md.vercel.app/api/badge/spotify)              |

| Stack Overflow (`stackoverflow`) | ![stack overflow](https://socialize-md.vercel.app/api/badge/stackoverflow) |

| Steam (`steam`)                  | ![steam](https://socialize-md.vercel.app/api/badge/steam)                  |

| Tiktok (`tiktok`)                | ![tiktok](https://socialize-md.vercel.app/api/badge/tiktok)                |

| Twitch (`twitch`)                | ![twitch](https://socialize-md.vercel.app/api/badge/twitch)                |

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

| Web (`web`)                      | ![web](https://socialize-md.vercel.app/api/badge/web)                      |

| Youtube (`youtube`)              | ![youtube](https://socialize-md.vercel.app/api/badge/youtube)              |

Like this project? Support me with ethereum: 0xD4c6325E42fac0625B25C0d4DB40823870986609