From 795dd21c71b92203b874173f1ccbdb9ae0dff1cd Mon Sep 17 00:00:00 2001 From: Hexagonn <128217934+hexaaagon@users.noreply.github.com> Date: Tue, 24 Sep 2024 15:48:15 +0700 Subject: [PATCH] feat(readme): fix markdown --- README.md | 45 ++++++++++++++++++++++----------------------- 1 file changed, 22 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 7dfb591..c80c47c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ - # lanyard-profile-readme 🏷️ Utilize Lanyard to display your Discord Presence in your GitHub Profile @@ -26,67 +25,67 @@ When others click it, they will be directed to your actual Discord profile. Neat There are a few options to customize this display using query parameters: -### **_Theme_** +### ___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. +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_** +### ___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_** +### ___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_** +### ___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_** +### ___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. +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_** +### ___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. +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_** +### ___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. +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_** +### ___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 Clan Tag_** +### ___Hide Clan Tag___ -If you don't want people seeing your Clan Tag (formerly known as Guilds), append the query param `hideClan=true` to the end of the URL. Clan Tag is shown by default. +If you don't want people seeing your Clan Tag (formerly known as Guilds), append the query param `hideClanTag=true` to the end of the URL. Clan Tag is shown by default. -### **_Hide Badges_** +### ___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_** +### ___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 Activity_** +### ___Hide Activity___ If you don't want people seeing the your activity, append the query param `hideActivity=true` to the end of the URL or use `hideActivity=whenNotUsed` to hide activity section when there's no activity to display. Activity are shown by default. -### **_Hide Spotify_** +### ___Hide Spotify___ If you don't want people seeing your Spotify activity, append the query param `hideSpotify=true` to the end of the URL. Spotify activity is shown by default. -### **_Hide App by ID_** +### ___Hide App by ID___ If you don't want display a specific application, append the query param `ignoreAppId=:app_id` to the end of the URL, IDs separate by `,`. -### **_Hide Discriminator_** (DEPRECATED soon) +### ___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. +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_** +## ___Example URL and result___ ``` [![Discord Presence](https://lanyard-profile-readme.vercel.app/api/94490510688792576?theme=light&bg=809ecf&animated=false&hideDiscrim=true&borderRadius=30px&idleMessage=Probably%20doing%20something%20else...)](https://discord.com/users/94490510688792576)