mirror of
https://github.com/devgg/fonticon.git
synced 2026-08-24 10:13:28 -05:00
51 lines
1.8 KiB
Markdown
51 lines
1.8 KiB
Markdown
# [fonticon](http://gauger.io/fonticon)
|
|
|
|
|
|
|
|
|
|
Tool for creating favicons and images from [Font Awesome](http://fontawesome.io/) icons. The generated icon can be previewed live in the browser.
|
|
|
|
<p align="center">
|
|
<img src="https://user-images.githubusercontent.com/8250067/41500849-e678252c-7199-11e8-9554-14a8bbae8653.gif">
|
|
</p>
|
|
|
|
# Features
|
|
|
|
- Latest Font Awesome 6.5.2
|
|
- Preview of favicon live in browser
|
|
- Download favicons with all features of [realfavicongenerator.net](https://realfavicongenerator.net)
|
|
- Color icon and background by specifying any valid [TinyColor](https://github.com/bgrins/TinyColor#accepted-string-input) value
|
|
- Transparent icon and background
|
|
- Fuzzy search and keyword search
|
|
- Support stacked icons
|
|
|
|
# Contributing
|
|
|
|
To contribute fork the repository and execute
|
|
|
|
```shell
|
|
git clone <YOUR_FORK>
|
|
cd fonticon
|
|
npm install
|
|
# Install pre-commit hooks for automatic code formatting (requires python to be installed).
|
|
npm run pre-commit
|
|
```
|
|
|
|
This installs all the necessary dependencies. Now you can build the code by running:
|
|
|
|
```shell
|
|
npm run build
|
|
```
|
|
|
|
Afterwards the `index.html` and other static assets can be found in the `dist` directory.
|
|
|
|
Alternatively, you can run:
|
|
|
|
```shell
|
|
npm run start:dev
|
|
```
|
|
|
|
This will start a [webpack-dev-server](https://github.com/webpack/webpack-dev-server). While the server is running you can go to [localhost:8080](http://localhost:8080) where all your changes will be reflected as soon as you save a file.
|
|
|
|
During your commit, all changed code will be formatted with [Prettier](https://prettier.io/) and [Black](https://github.com/ambv/black) so no need to worry about formatting 😄🎉.
|