Special thanks to @cnrad for creating this project, it's my inspiration for this project.
First, go to this website and login your google account.
You have two options to share your social profiles, first is by adding it in your README.md
file and by adding it in your bio.
- For adding in your
README.md
, copy this and replace:userId
with your userId (found on the website).
[![Discord Presence](https://social-profiles.tiaansu.vercel.app/api/social-profiles/:id/github)](https://social-profiles.tiaansu.vercel.app/:id)
It should display something similar to the following:
- For adding in your bio, copy this and replace
:userId
with your userId (found on the website).
https://social-profiles.tiaansu.vercel.app/:userId
There are few options to customize this display using query parameters:
-
Theme
- Append the query param
theme=:theme
to the end of the URL, replacing:theme
with eitherlight
ordark
. This will change the background and the font colors, but the background can be overridden with the Background Color parameter.
- Append the query param
-
Background Color
- Append the query param
bg=:bg
to the end of the URL, replacing:color
with a hex color of your choice (omit the #)
- Append the query param
-
Border Radius
- Append the query param
borderRadius=:radius
to the end of the URL, replacing:radius
with a radius of your choice. (default10px
)
- Append the query param
Note
If you're using this in your profile, feel free to show support and give this repo a ⭐ star! It means a lot, thank you :)
If you also did like this project, consider sponsoring me (long url is not that good, right?)
Note
Contributing is open so if you want to change something or add something, you can do so.