lanyard-profile-readme
๐ท๏ธ Utilize Lanyard to display your Discord Presence in your GitHub Profile
Special thanks to @Phineas for creating Lanyard, and making this project possible
Usage
First, join the Lanyard Discord (if you haven't already) for this to work.
In a README.md file, include the following, replacing :id with your Discord user ID:
[](https://discord.com/users/:id)It should display something similar to the following (I am using my Discord user ID as an example):
When others click it, they will be directed to your actual Discord profile. Neat!
Options
There are a 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 either light or dark. This will change the background and the font colors, but the background can be overridden with the Background Color parameter.
Background Color
Append the query param bg=:color to the end of the URL, replacing :color with a hex color of your choice (omit the #)
Border Radius
Append the query param borderRadius=:radius to the end of the URL, replacing :radius with a radius of your choice. (default 10px)
Toggle Animated Avatar
If you have an animated avatar, append the query param animated=:bool to the end of the URL, replacing :bool with true or false. This is set to true by default.
Custom Idle Message
If you don't want the default "I'm not currently doing anything!" as your idle message, you can change it by appending idleMessage=:yourmessage to the end of the URL.
Show Display Name
If you'd like to show your global display name as well as your username, append the query param showDisplayName=true to the end of the URL. This is set to false by default.
Hide Status
If you don't want people seeing your status, append the query param hideStatus=true to the end of the URL. Your status is shown by default if you have one.
Hide Elapsed Time
If you don't want people seeing the elapsed time on an activity, append the query param hideTimestamp=true to the end of the URL. Elapsed time is shown by default.
Hide Badges
If you don't want people seeing the badges you have on Discord, append the query param hideBadges=true to the end of the URL. Badges are shown by default.
Hide Profile
If you don't want people seeing the profile you have on Discord, append the query param hideProfile=true to the end of the URL. Profile are shown by default.
Hide Discriminator (DEPRECATED soon)
If you don't want people seeing your discriminator (most likely for privacy reasons), append the query param hideDiscrim=true to the end of the URL. Your discriminator is shown by default.
Example URL and result
[](https://discord.com/users/94490510688792576)
Note: Current Nitro & Boosting badges do not work due to Discord API limitations, unless you currently have an animated avatar, in which case it will display the Nitro badge.
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 :)