Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/traum-ferienwohnungen/fontfare
https://github.com/traum-ferienwohnungen/fontfare
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/traum-ferienwohnungen/fontfare
- Owner: traum-ferienwohnungen
- License: gpl-3.0
- Created: 2019-05-15T08:15:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T03:29:50.000Z (almost 2 years ago)
- Last Synced: 2024-03-26T19:36:30.486Z (8 months ago)
- Language: Handlebars
- Size: 2.13 MB
- Stars: 0
- Watchers: 7
- Forks: 4
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FontFare
> _Fare_ is the [Maori](https://translate.google.com/#mi/en/fare). word for *Home* .
## Installing
```bash
npm install @traum-ferienwohnungen/fontfare
cp node_modules/@traum-ferienwohnungen/fontfare/dist/ YOUR_DIRECTORY
```
```scss
@import ~/@traum-ferienwohnungen/fontfare/dist/scss/_fontfare;
$font-path: "YOUR_DIRECTORY";
```
## Using the icons
Using the icons is a simple as adding two classes to your DOM Node.
The `ff` class implies that the element should be a `f`ont`f`are icon.
Then just add the name of the icon you want to use.
> Example.
> 
> `airport.svg` becomes `ff-airport`
```html
```
## Developer guide
```bash
# Use the node version specified in .nvmrc
nvm use
# Install packages
npm i
# Add files to icons folder
# Generate font
npm run build
```