Skip to content

Commit

Permalink
Release 14.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jan 19, 2025
2 parents 604be7d + e2a1ed0 commit 6cc204a
Show file tree
Hide file tree
Showing 6 changed files with 1,183 additions and 1,133 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/renovate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
- name: Setup node
uses: actions/setup-node@v4
- name: Renovate
uses: renovatebot/github-action@v40.1.11
uses: renovatebot/github-action@v40.3.4
with:
configurationFile: .github/renovate.json5
token: ${{ steps.app-token.outputs.token }}
Expand Down
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,38 @@ Where `[ICON NAME]` is replaced by the icon name, for example:

In this example we use the `<i>` tag, but any inline HTML tag should work as you expect.

## Custom Builds

You can specify which icons need to be build for a smaller file size.

1. Clone and install dependencies:

```shell
git clone git@github.com:simple-icons/simple-icons-font.git
cd simple-icons-font
npm install
```

2. Use the environment variable `SI_FONT_SLUGS_FILTER` to filter icons to include:

```shell
SI_FONT_SLUGS_FILTER=github,simpleicons npm run build
```

Next environment variables are available to customize the build:

- `SI_FONT_SLUGS_FILTER`: Comma separated string of slugs to include in the build. See [all slugs].
- `SI_FONT_PRESERVE_UNICODES`: By default, the build will retain the same unicode of an icon as the full build. You can set it to `false` to disable this.

For example, if you set `SI_FONT_PRESERVE_UNICODES` to `false`, the unicode will still start at `0xea01` and keep increasing even you skipped some icons:

```shell
SI_FONT_SLUGS_FILTER=github,simpleicons SI_FONT_PRESERVE_UNICODES=false npm run build
#=> github \u{EA01}
#=> simpleicons \u{EA02}
```

[latest-release]: https://github.com/simple-icons/simple-icons-font/releases/latest
[jsdelivr-link]: https://www.jsdelivr.com/package/npm/simple-icons-font/
[unpkg-link]: https://unpkg.com/browse/simple-icons-font/
[all slugs]: https://github.com/simple-icons/simple-icons/blob/develop/slugs.md
Loading

0 comments on commit 6cc204a

Please sign in to comment.