https://github.com/neilveil/icon-sheet
Generate Icon Font from SVG files
https://github.com/neilveil/icon-sheet
browser-fonts font-generator icon-sheet icons svg-to-font svg-to-ttf web-font
Last synced: about 1 month ago
JSON representation
Generate Icon Font from SVG files
- Host: GitHub
- URL: https://github.com/neilveil/icon-sheet
- Owner: neilveil
- License: mit
- Created: 2023-09-13T09:10:39.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-10-18T02:31:28.000Z (almost 2 years ago)
- Last Synced: 2025-08-20T21:21:01.540Z (about 2 months ago)
- Topics: browser-fonts, font-generator, icon-sheet, icons, svg-to-font, svg-to-ttf, web-font
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/icon-sheet
- Size: 45.9 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license.txt
Awesome Lists containing this project
README
# Icon Sheet
[](https://www.npmjs.com/package/icon-sheet) [](https://www.npmjs.com/package/icon-sheet)
Effortlessly Generate Icons from SVG files for ReactJS, VueJS, Angular, and Front-end Projects, Empowering Your UI Development.
## Why Icon Sheet?
- Light-weight
- Flexible
- Simple to use
With Icon-Sheet, you can seamlessly integrate custom icons into your web applications, enhancing user experience and visual appeal. Say goodbye to the hassle of manual icon creation and hello to a streamlined development process.
Whether you're building a dynamic web application or a responsive website, Icon-Sheet provides a straightforward solution for implementing icons that align perfectly with your design vision. Elevate your front-end projects with this powerful tool and experience the difference.
## Installation
```bash
npm install icon-sheet
```
## Setup
Put all your `.svg` in `icons` directory at the root of your project.
In your `package.json`` file, add a script:
```json
"scripts": {
"icon-sheet": "icon-sheet"
},
```
Then run the command
```bash
npm run icon-sheet
```
**Arguments**
- `--iconsDir`: SVG icons directory. (Default: `icons`)
- `--ttfPath`: Generated TTF font path. (Default: `icon-sheet.ttf`)
- `--woffPath`: Generated WOFF font path. (Not generated by default)
- `--woff2Path`: Generated WOFF2 font path. (Not generated by default)
- `--stylesPath`: Generated styles path (Default: `icon-sheet.css`)
Example
```json
"scripts": {
"icon-sheet": "icon-sheet --iconsDir=src/svgs-icons"
},
```
## Usage
```html
..
..
..
..
my_icon
..
```
Icon name is same as the svg file name, `icons/my_icon.svg`.
## Contributing
Contributions are welcome! Feel free to open an issue or submit a pull request.
## License
This project is licensed under the [MIT License](./license.txt).
## Developer
Developed & maintained by [neilveil](https://github.com/neilveil).