https://github.com/shift72/icon-font-generator
https://github.com/shift72/icon-font-generator
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/shift72/icon-font-generator
- Owner: shift72
- Created: 2021-11-07T22:02:07.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-12-06T22:22:51.000Z (over 4 years ago)
- Last Synced: 2025-02-05T22:59:31.949Z (over 1 year ago)
- Language: JavaScript
- Size: 71.3 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# icon-font-generator
This repository generates icon fonts for [core-template](https://github.com/shift72/core-template) using the [fantasticon](https://www.npmjs.com/package/fantasticon) npm package. The necessary files are copied into core-template automatically and will override any fonts and css that already exist. The file paths for the generated files can be found in `.fantasticonrc.js`
You can view the icons by going to `/icons.html`
### Setup
1. Clone this repo into the same parent directory as core-template.
2. `npm i` inside the icon-font-generator directory.
### Generating Fonts
1. Add SVG icons to the `src` folder. Icons must be 24px by 24px.
2. `npm run create-icons`.
3. In core-template, open `site/icons.html.jet`.
4. Change the stylesheet link to point to the styles folder ``
### Usage
``
A unique class is generated from the SVG name with the `icon` prefix added.