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

Join the Discord server (required, as that's where the bot gets your presence information from)
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

Create an invite for your server; make sure to set it to never expire!
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

DM me () your bot's invite link
Wait for me to read the DM (it might take some time as it's a manual process)
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	`?style=flat`
	flat-square	`?style=flat-square`
	for-the-badge	None (default)
	plastic	`?style=plastic`
	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	None (default)
	Default inverted	`?theme=default-inverted`
	Clean	`?theme=clean`
	Clean inverted	`?theme=clean-inverted`
	Discord	`?theme=discord`
	Discord inverted	`?theme=discord-inverted`
	Full presence	`?theme=full-presence`
	Gray	`?theme=gray`
	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=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
	`?logoColor=presence`	Changes the color of the logo according to the presence
	`?logoColor=pink`	Supported colors here
	`?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 (mdbadge@limes.pink)

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"
/>

gitlimes/discord-md-badge