From ed76079f606c4b78a45ce8667a5eb1f163e89235 Mon Sep 17 00:00:00 2001 From: Sean van Zuidam Date: Wed, 16 Oct 2024 06:41:08 +0200 Subject: [PATCH 1/2] ADD: Hyva Feather icons as Related Projects (#1132) --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index aba91d92..a89bd58e 100644 --- a/README.md +++ b/README.md @@ -403,6 +403,7 @@ Caught a mistake or want to contribute to the documentation? [Edit this page on - [sketch-feather](https://github.com/odmln/sketch-feather) - Feather icons as a Sketch library - [vue-feather-icons](https://github.com/egoist/vue-feather-icons) - Feather icons as Vue components - [php-feather](https://github.com/Pixelrobin/php-feather) - Feather icons as a PHP Library +- [hyva-feather](https://github.com/Siteation/magento2-hyva-icons-feather) - Feather icons as a Magento 2 Hyva template tag - [wp-php-feather](https://github.com/reatlat/wp-php-feather) - Feather icons as a WordPress template tag - [django-feather](https://pypi.org/project/django-feather/) - Feather icons as Django Template Tag - [svelte-feather-icons](https://github.com/dylanblokhuis/svelte-feather-icons) - Feather icons as Svelte components From 72bb300f4a1e63354b5b5153b33011eaa54b6782 Mon Sep 17 00:00:00 2001 From: Kurt McKee Date: Thu, 6 Mar 2025 07:28:44 -0600 Subject: [PATCH 2/2] Fix broken Note, Important, and Warning callout syntax Spotted while reviewing the README. --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a89bd58e..3a88f40c 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,8 @@ Include `feather.js` or `feather.min.js` with a ` ``` -> [!NOTE] > `feather.js` and `feather.min.js` are located in the `dist` directory of the npm package. +> [!NOTE] +> `feather.js` and `feather.min.js` are located in the `dist` directory of the npm package. Or load the script from a CDN provider: @@ -198,7 +199,8 @@ Include an icon on your page with the following markup: ``` -> [!NOTE] > `circle` in the above example can be replaced with any valid icon name. See the complete list of icon names at [feathericons.com](https://feathericons.com). +> [!NOTE] +> `circle` in the above example can be replaced with any valid icon name. See the complete list of icon names at [feathericons.com](https://feathericons.com). However, this markup can be simplified using a simple CSS class to avoid repetition of SVG attributes between icons: @@ -257,7 +259,8 @@ feather.icons.x.toString(); // '' ``` -> [!NOTE] > `x` in the above example can be replaced with any valid icon name. See the complete list of icon names at [feathericons.com](https://feathericons.com). Icons with multi-word names (e.g. `arrow-right`) **cannot** be accessed using dot notation (e.g. `feather.icons.x`). Instead, use bracket notation (e.g. `feather.icons['arrow-right']`). +> [!NOTE] +> `x` in the above example can be replaced with any valid icon name. See the complete list of icon names at [feathericons.com](https://feathericons.com). Icons with multi-word names (e.g. `arrow-right`) **cannot** be accessed using dot notation (e.g. `feather.icons.x`). Instead, use bracket notation (e.g. `feather.icons['arrow-right']`). [View Source](https://github.com/feathericons/feather/blob/master/src/icons.js) @@ -312,7 +315,8 @@ Replaces all elements that have a `data-feather` attribute with SVG markup corre #### Usage -> [!IMPORTANT] > `feather.replace()` only works in a browser environment. +> [!IMPORTANT] +> `feather.replace()` only works in a browser environment. Simple usage: @@ -362,7 +366,8 @@ All attributes on the placeholder element (i.e. ``) will be copied to the ` [!WARNING] > `feather.toSvg()` is deprecated. Please use `feather.icons[name].toSvg()` instead. +> [!WARNING] +> `feather.toSvg()` is deprecated. Please use `feather.icons[name].toSvg()` instead. Returns an SVG string.