mirror of
https://github.com/NohamR/lanyard-profile-readme.git
synced 2026-05-25 20:00:40 +00:00
54 lines
2.3 KiB
Markdown
54 lines
2.3 KiB
Markdown
<!-- markdownlint-disable -->
|
|
# lanyard-profile-readme
|
|
|
|
🏷️ Utilize Lanyard to display your Discord Presence in your GitHub Profile
|
|
|
|
_Special thanks to [@Phineas](https://github.com/Phineas/) for creating Lanyard, and making this project possible_
|
|
|
|
## Usage
|
|
|
|
First, join the Lanyard [Discord](https://discord.gg/wscam7vngf) (if you haven't already) for this to work.
|
|
|
|
In a `README.md` file, include the following, replacing `:id` with your Discord user ID:
|
|
|
|
```md
|
|
[](https://discord.com/users/:id)
|
|
```
|
|
|
|
It should display something similar to the following (I am using my Discord user ID as an example):
|
|
|
|
[](https://discord.com/users/705665813994012695)
|
|
|
|
When others click it, they will be directed to your actual Discord profile. Neat!
|
|
|
|
## Options (wip)
|
|
|
|
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 #)
|
|
|
|
### ___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.
|
|
|
|
### ___Hide Discriminator___
|
|
|
|
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)
|
|
```
|
|
|
|
[](https://discord.com/users/94490510688792576)
|
|
|
|
\
|
|
_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 :)_
|