https://github.com/runxel/kirby3-simpleicons
A plugin for Kirby 3 to get simple-icons in Kirbytext.
https://github.com/runxel/kirby3-simpleicons
icons kirby kirbytext simple-icons
Last synced: 21 days ago
JSON representation
A plugin for Kirby 3 to get simple-icons in Kirbytext.
- Host: GitHub
- URL: https://github.com/runxel/kirby3-simpleicons
- Owner: runxel
- License: mit
- Created: 2019-11-30T17:30:18.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-24T17:49:10.000Z (about 1 year ago)
- Last Synced: 2025-04-05T10:46:27.957Z (27 days ago)
- Topics: icons, kirby, kirbytext, simple-icons
- Language: PHP
- Size: 16.6 KB
- Stars: 9
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# [Simple-Icons for Kirby](https://github.com/runxel/kirby3-simpleicons)
[](https://packagist.org/packages/runxel/kirby-simpleicons)
A plugin for Kirby 3 to have an easy access to [simple-icons](https://github.com/simple-icons/simple-icons) in Kirbytext.
This plugin allows you to use almost any major brand icon you'd want, without having to source, optimize, and upload these logos yourself.
### Similar plugin
"But I don't need _brands_!"
→ Yeah, maybe [this](https://github.com/julien-gargot/kirby-plugin-fontawesome-icon) is what you're looking for then :)
---
## Installation
Choose one of the following:
- Using composer: `composer require runxel/kirby-simpleicons`; the plugin will automagically appear in `site/plugins`.
- Download a zip of the [latest release](https://github.com/runxel/kirby3-simpleicons/releases/latest) and put the contents into `site/plugins/simpleicons`.
Please be aware you have to solve the [dependencies](#dependencies) on your own.
Git Submodules is currently not supported, but you can try that anyway, of course :)
### Dependencies
Please be aware that this plugin uses the [simple-icons Composer package](https://packagist.org/packages/simple-icons/simple-icons).
If you're not using composer to install the plugin you have to download the icons by yourself.
Even tho there are CDNs available I don't recommend to use them. SVG can have executable code and also the CDN can track users on your site.
## Usage
As simple as using `(icon:brandname)` in a text.
Works wherever your text will be rendered as [Kirbytext](https://getkirby.com/docs/reference/text/kirbytags).
The svg will be served _inline_ [[1]](#f1) and inside a span with a fixed class of `.simpleicon`.
You can however specify your own, additional class like this `(icon:github class:myclass)`
To see all available icons please go to [simpleicons.org](https://simpleicons.org/).
If you think there is an icon missing **DO NOT** request it here, but at the [simple-icons repo](https://github.com/simple-icons/simple-icons/issues/new/choose).
[1] This is done so you can style it with a `fill` thru CSS. [↩](#a1)
## Configuration
To assure the svgs won't look off, you need some proper styling via **CSS**, like the following:
```css
.simpleicon { /* span */
display: inline-block; /* important! */
/* size can be adjusted to your taste */
height: 1em;
width: 1em;
fill: var(--text-color); /* color the svg */
}
.simpleicon svg { /* not a must, just for your taste */
vertical-align: middle;
}
```
## Disclaimer
This plugin is provided "as is" with no guarantee. If you find any issues, please [create a new issue](https://github.com/runxel/kirby3-simpleicons/issues/new).