Skip to content

Fix broken Note, Important, and Warning callout syntax #1267

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
colebemis merged 1 commit into from
Mar 11, 2025
+10 −5
Merged

Fix broken Note, Important, and Warning callout syntax #1267

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@ Include `feather.js` or `feather.min.js` with a `<script>` tag:
<script src="path/to/dist/feather.js"></script>
```

> [!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:

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

> [!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:

Expand Down Expand Up @@ -257,7 +259,8 @@ feather.icons.x.toString();
// '<line ... /><line ... />'
```

> [!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)

Expand Down Expand Up @@ -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:

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

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

> [!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.

Expand Down