Skip to content

Latest commit

 

History

History
140 lines (101 loc) · 6.53 KB

README.md

File metadata and controls

140 lines (101 loc) · 6.53 KB
Raw

simple-icons-cdn

Colorable and resizable CDN for Simple Icons

Disclaimer

We ask that all users read the legal disclaimer before using icons from Simple Icons.

Usage

GET https://cdn.simpleicons.org/:icon_slug/:color?/:dark_mode_color?

Parameters

icon_slug

You can simply click the icon title on simpleicons.org to copy the slug.

All icon slugs can be found at slugs.md.

color

Optional. Default to the color of icon from simpleicons.org. It supports hex colors and CSS keywords. Passing in an invalid value will use the default color as a fallback.

dark_mode_color

Optional. It's used for dark mode and has the same function as color. The CSS prefers-color-scheme will be used when a value is specified.

viewbox

Optional. The icon is placed in a square viewBox by default. Use the query parameter viewbox=auto to adjust the viewBox to the same aspect ratio as the shape.

size

Optional. It's used for customizing the icon size. Use the query parameter size to scale with its original aspect ratio.

Examples

Auto-sized

This is useful if you want all icons rendered with consitent size.

<img height="20" src="https://cdn.simpleicons.org/javascript?viewbox=auto" />
<img height="20" src="https://cdn.simpleicons.org/python?viewbox=auto" />
<img height="20" src="https://cdn.simpleicons.org/kotlin?viewbox=auto" />
<img height="20" src="https://cdn.simpleicons.org/dart?viewbox=auto" />
<img height="20" src="https://cdn.simpleicons.org/r?viewbox=auto" />
<img height="20" src="https://cdn.simpleicons.org/swift?viewbox=auto" />
<img height="20" src="https://cdn.simpleicons.org/julia?viewbox=auto" />
<img height="20" src="https://cdn.simpleicons.org/haskell?viewbox=auto" />
<img height="20" src="https://cdn.simpleicons.org/clojure?viewbox=auto" />

Other usages

Raycast

Easily browse, search, and copy icon SVG source, brand color, guidelines, and CDN links with Raycast.

Notion

You can use this icon CDN anywhere in Notion which allows you to insert a custom image or icon.

Terminal

It's possible to use icons from the terminal emulator since iTerm2 has special image support.

imgcat -u 'https://cdn.simpleicons.org/go'
imgcat -u 'https://cdn.simpleicons.org/go?viewbox=auto'
imgcat -u 'https://cdn.simpleicons.org/go?viewbox=auto&size=48'

Domain aliases

Related

  • Simple Icons - Icon provider of the CDN service
  • Brand Icons - Raycast extension that makes it easy to search and copy CDN links

License

MIT