Skip to content

Commit 3dc050d

Browse files
authored
Merge pull request #1267 from kurtmckee/fix-readme
Fix broken Note, Important, and Warning callout syntax
2 parents ed76079 + 72bb300 commit 3dc050d

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,8 @@ Include `feather.js` or `feather.min.js` with a `<script>` tag:
8383
<script src="path/to/dist/feather.js"></script>
8484
```
8585

86-
> [!NOTE] > `feather.js` and `feather.min.js` are located in the `dist` directory of the npm package.
86+
> [!NOTE]
87+
> `feather.js` and `feather.min.js` are located in the `dist` directory of the npm package.
8788
8889
Or load the script from a CDN provider:
8990

@@ -198,7 +199,8 @@ Include an icon on your page with the following markup:
198199
</svg>
199200
```
200201

201-
> [!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).
202+
> [!NOTE]
203+
> `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).
202204
203205
However, this markup can be simplified using a simple CSS class to avoid repetition of SVG attributes between icons:
204206

@@ -257,7 +259,8 @@ feather.icons.x.toString();
257259
// '<line ... /><line ... />'
258260
```
259261

260-
> [!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']`).
262+
> [!NOTE]
263+
> `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']`).
261264
262265
[View Source](https://github.com/feathericons/feather/blob/master/src/icons.js)
263266

@@ -312,7 +315,8 @@ Replaces all elements that have a `data-feather` attribute with SVG markup corre
312315

313316
#### Usage
314317

315-
> [!IMPORTANT] > `feather.replace()` only works in a browser environment.
318+
> [!IMPORTANT]
319+
> `feather.replace()` only works in a browser environment.
316320
317321
Simple usage:
318322

@@ -362,7 +366,8 @@ All attributes on the placeholder element (i.e. `<i>`) will be copied to the `<s
362366

363367
### `feather.toSvg(name, [attrs])` (DEPRECATED)
364368

365-
> [!WARNING] > `feather.toSvg()` is deprecated. Please use `feather.icons[name].toSvg()` instead.
369+
> [!WARNING]
370+
> `feather.toSvg()` is deprecated. Please use `feather.icons[name].toSvg()` instead.
366371
367372
Returns an SVG string.
368373

0 commit comments

Comments
 (0)