Skip to content

Instantly share code, notes, and snippets.

@cxmeel
Last active November 3, 2024 10:08
Show Gist options
  • Save cxmeel/b3af232eba0ace022e2fba8b7b286520 to your computer and use it in GitHub Desktop.
Save cxmeel/b3af232eba0ace022e2fba8b7b286520 to your computer and use it in GitHub Desktop.
Documentation for markdown buttons.

Markdown Buttons

A collection of SVG buttons for displaying custom "buttons" in Markdown content. You are free to use these buttons wherever you like. All buttons were created in Figma, with (most) icons provided by the Iconify plugin.

Sponsor on GitHub View Itch.io Store

The SVG files can be found on this gist. They have been separated in order to reduce the amount of lag when loading this README file.

Important Notes

  • If you have linked to the Twitter button, it'll automatically update to show the X logo. If you would like to continue using the Twitter logo, please use the Twitter (Legacy) icon instead.

Linking to Buttons

To link to a button, use the following URL, replacing "SERVICE" with the service name (see services table below). Additionally, some buttons have animated, icon and compact variants, which can be accessed by appending either -animated, -compact or -icon to the service name.

https://gist.github.com/cxmeel/0dbc95191f239b631c3874f4ccf114e2/raw/SERVICE.svg

Embedding in Markdown

Use standard markdown formatting to embed these buttons. For example, to create a button that proceeds to a link when clicked, use the following format:

[![Get it on SERVICE](https://gist.github.com/cxmeel/0dbc95191f239b631c3874f4ccf114e2/raw/SERVICE.svg)](https://example.com/...)

Resizing

Services like Discourse allow for markdown images to be resized. This is especially useful when you want to create a row of buttons that include compact-style and icon buttons. Compact buttons are 32px height. You can use this to create small icon buttons using the following syntax:

Sponsor on GitHub View Itch.io Store

[![Get it on SERVICE|32x32](https://gist.github.com/cxmeel/0dbc95191f239b631c3874f4ccf114e2/raw/SERVICE-icon.svg)](https://example.com/...)

Other services, like GitHub, may require you to use HTML instead. Usually you can mix <img /> tags with markdown syntax:

[<img src="https://gist.github.com/cxmeel/0dbc95191f239b631c3874f4ccf114e2/raw/SERVICE-icon.svg" alt="Get it on SERVICE" height="32" />](https://example.com/...)

Examples

Example Service Name Variant Name URL suffix
Roblox Developer roblox_dev roblox_dev.svg
Roblox Developer (Icon) roblox_dev -icon roblox_dev-icon.svg
Roblox Developer (Compact) roblox_dev -compact roblox_dev-compact.svg
Roblox Developer (Animated) roblox_dev -animated roblox_dev-animated.svg

Services

Services are now grouped alphabetically. You can use the list below to quickly jump to a letter.

A B C D E F G H I
J K L M N O P Q R
S T U V W X Y Z 0
1 2 3 4 5 6 7 8 9

B

Example Service Name Caption Default (Large) Compact Icon Animated
Behance behance FOLLOW ✔️ ✔️ ✔️
BitBucket bitbucket GET IT ON ✔️ ✔️ ✔️
BitBucket Source bitbucket_source SOURCE ✔️

C

Example Service Name Caption Default (Large) Compact Icon Animated
Crates.io crates_io GET IT ON ✔️ ✔️ ✔️

D

Example Service Name Caption Default (Large) Compact Icon Animated
Discord discord JOIN US ✔️ ✔️ ✔️
Documentation documentation ✔️ ✔️ ✔️
Docs docs ✔️ ✔️
Documentation - Learn More documentation_learn DOCUMENTATION ✔️
Download download ✔️ ✔️ ✔️
Dribbble dribbble FOLLOW ✔️ ✔️ ✔️

F

Example Service Name Caption Default (Large) Compact Icon Animated
Facebook facebook JOIN US ✔️ ✔️ ✔️
Facebook (Like) facebook_like LIKE ON ✔️
Figma (Blue) figma_blue GET IT ON ✔️ ✔️ ✔️
Figma (Green) figma_green GET IT ON ✔️ ✔️ ✔️
Figma (Purple) figma_purple GET IT ON ✔️ ✔️ ✔️
Figma (Red) figma_red GET IT ON ✔️ ✔️ ✔️

G

Example Service Name Caption Default (Large) Compact Icon Animated
GitHub github GET IT ON ✔️ ✔️ ✔️
GitHub Source github_source SOURCE ✔️
GitHub Sponsor github_sponsor GitHub ✔️ ✔️ ✔️
GitLab gitlab GET IT ON ✔️ ✔️ ✔️
GitLab Source gitlab_source SOURCE ✔️
Guilded guilded JOIN US ✔️ ✔️ ✔️

I

Example Service Name Caption Default (Large) Compact Icon Animated
Instagram instagram FOLLOW ✔️ ✔️ ✔️
Itch.io itch GET IT ON ✔️ ✔️ ✔️

L

Example Service Name Caption Default (Large) Compact Icon Animated
Lua lua ✔️ ✔️ ✔️
Luau luau ✔️ ✔️ ✔️

M

Example Service Name Caption Default (Large) Compact Icon Animated
Mastodon mastodon FOLLOW ✔️ ✔️ ✔️

N

Example Service Name Caption Default (Large) Compact Icon Animated
NPM npm GET IT ON ✔️ ✔️ ✔️

P

Example Service Name Caption Default (Large) Compact Icon Animated
Patreon patreon SUPPORT ✔️ ✔️ ✔️
Play play ✔️ ✔️ ✔️

R

Example Service Name Caption Default (Large) Compact Icon Animated
Roblox roblox GET IT ON ✔️ ✔️ ✔️
Roblox (Play) roblox_play PLAY ON ✔️
Roblox (Join) roblox_join JOIN ON ✔️
Roblox Developer roblox_dev GET IT ON ✔️ ✔️ ✔️ ✔️
Roblox Developer (Creator Store) roblox_dev_creator_store ✔️ ✔️
Roblox Developer (Marketplace) roblox_dev_marketplace ✔️ ✔️
Roblox Developer (Store) roblox_dev_store ✔️ ✔️
Roblox Developer (Play) roblox_dev_play PLAY ON ✔️
Roblox Developer (Join) roblox_dev_join JOIN ON ✔️
Roblox TS roblox_ts ✔️ ✔️ ✔️
Rust rust ✔️ ✔️ ✔️

T

Example Service Name Caption Default (Large) Compact Icon Animated
TikTok tiktok FOLLOW ✔️ ✔️ ✔️
Twitter twitter FOLLOW ✔️ ✔️ ✔️
Twitter (Legacy) twitter_legacy FOLLOW ✔️ ✔️ ✔️
TypeScript typescript ✔️ ✔️ ✔️

W

Example Service Name Caption Default (Large) Compact Icon Animated
Wally wally GET IT ON ✔️ ✔️ ✔️

X

Example Service Name Caption Default (Large) Compact Icon Animated
X x FOLLOW ✔️ ✔️ ✔️

Y

Example Service Name Caption Default (Large) Compact Icon Animated
Yarn yarn GET IT ON ✔️ ✔️ ✔️
YouTube youtube SUBSCRIBE ✔️ ✔️ ✔️
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment