Skip to content

A customizable badge displaying your Discord account, a server invite, or a bot account.

License

Notifications You must be signed in to change notification settings

gitlimes/discord-md-badge

Repository files navigation

Discord Markdown Badge

A customizable badge that shows your Discord account, a server invite, or a bot account.

User Account
Server Invite
Bot Account

Set up

User Account   

  1. Join the Discord server (required, as that's where the bot gets your presence information from)
  2. Your shield will become available at https://dcbadge.limes.pink/api/shield/USERID
    (replace USERID with your Discord user ID)

To embed the shield in a Markdown file, do this:
![](https://dcbadge.limes.pink/api/shield/USERID)

Server Invite   

  1. Create an invite for your server; make sure to set it to never expire!
  2. Your shield will become available at https://dcbadge.limes.pink/api/server/INVITE
    (e.g. https://dcbadge.limes.pink/api/server/https://discord.gg/zkspfFwqDg)

To embed the shield in a Markdown file, do this:
[![](https://dcbadge.limes.pink/api/server/INVITE)](https://discord.gg/INVITE)

Bot Account   

  1. DM me () your bot's invite link
  2. Wait for me to read the DM (it might take some time as it's a manual process)
  3. Your shield will become available at https://dcbadge.limes.pink/api/shield/BOTID?bot=true
    (replace BOTID with your Discord bot's user ID)

To embed the shield in a Markdown file, do this:
![](https://dcbadge.limes.pink/api/shield/BOTID?bot=true)

Styling

You can chain parameters by connecting them with & (e.g. ?style=flat&theme=clean&compact=true).

style

This uses shields.io under the hood, so you can just use one of the styles from there via the ?style= param.

Badge Style Query
flat flat ?style=flat
flat-square flat-square ?style=flat-square
for-the-badge (default) for-the-badge None (default)
plastic plastic ?style=plastic
social social ?style=social

theme

You can also use the theme query option to change the colors of the shield (the green in the following badges corresponds to the online/idle/dnd/offline status)

Badge Theme Query
default Default None (default)
default-inverted Default inverted ?theme=default-inverted
clean Clean ?theme=clean
clean-inverted Clean inverted ?theme=clean-inverted
dc Discord ?theme=discord
dc-inverted Discord inverted ?theme=discord-inverted
full-presence Full presence ?theme=full-presence
grey Gray ?theme=gray
blurple Blurple ?theme=blurple

Note: the theme option will not work with the social style.

compact

Makes the badge more compact, at the expense of the status text/member count.

Badge Query
compact ?compact=true

logoColor

You can pass a color for the logo (the examples below use &theme=default-inverted to make the change more evident)

Badge Query Description
presence ?logoColor=presence Changes the color of the logo according to the presence
word ?logoColor=pink Supported colors here
hex ?logoColor=ff6b6b Any hex code, without the #

I've added this to my GitHub bio and it doesn't work!

This won't work in bios, only in profile readmes (and any other part of GitHub that supports markdown). Here's some info on what a profile readme is and how to set it up.

For any questions feel free to contact me on Discord () or via email ([email protected])

HTML

The API returns an SVG image, so you can embed it in your html just like you would with any other image:

<img
  src="https://dcbadge.limes.pink/api/shield/USERID"
  alt="write a description depending on your usage"
/>