mirror of
https://github.com/FortAwesome/Font-Awesome.git
synced 2024-11-20 11:14:28 +00:00
39 lines
1.3 KiB
Markdown
39 lines
1.3 KiB
Markdown
|
# @fortawesome/fontawesome-free - The Official Font Awesome 5 NPM package
|
||
|
|
|
||
|
|
> "I came here to chew bubblegum and install Font Awesome 5 - and I'm all out of bubblegum"
|
||
|
|
|
||
|
|
[](https://www.npmjs.com/package/@fortawesome/fontawesome-free)
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
```
|
||
|
|
$ npm i --save @fortawesome/fontawesome-free
|
||
|
|
```
|
||
|
|
|
||
|
|
Or
|
||
|
|
|
||
|
|
```
|
||
|
|
$ yarn add @fortawesome/fontawesome-free
|
||
|
|
```
|
||
|
|
|
||
|
|
## What's included?
|
||
|
|
|
||
|
|
**This package includes all the same files available through our Free and Pro CDN.**
|
||
|
|
|
||
|
|
* /js - All JavaScript files associated with Font Awesome 5 SVG with JS
|
||
|
|
* /css - All CSS using the classic Web Fonts with CSS implementation
|
||
|
|
* /sprites - SVG icons packaged in a convenient sprite
|
||
|
|
* /scss, /less - CSS Pre-processor files for Web Fonts with CSS
|
||
|
|
* /webfonts - Accompanying files for Web Fonts with CSS
|
||
|
|
* /svg - Individual icon files in SVG format
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
Get started [here](https://fontawesome.com/get-started). Continue your journey [here](https://fontawesome.com/how-to-use).
|
||
|
|
|
||
|
|
Or go straight to the [API documentation](https://fontawesome.com/how-to-use/font-awesome-api).
|
||
|
|
|
||
|
|
## Issues and support
|
||
|
|
|
||
|
|
Start with [GitHub issues](https://github.com/FortAwesome/Font-Awesome/issues) and ping us on [Twitter](https://twitter.com/fontawesome) if you need to.
|