File: README.md
Version 7
Font Awesome is the Internet's icon library and toolkit, used by millions of
designers, developers, and content creators.
Documentation
Learn how to get started with Font Awesome and then dive deeper into other and advanced topics:
Where did Font Awesome 6, 5, 4 (or 3) go?
Now that Font Awesome 7 has been released we are marking version 6 as Long Term
Support (LTS). Version 6 will get critical bug fixes only. Version 3, 4, and 5 are
now end-of-life and we don't plan on releasing any further versions of these.
You can see a complete list of versions on our Versions
page.
Change log
The change log for releases is now available directly on our site.
Looking for older versions of Font Awesome? Check the releases.
Upgrading
From time-to-time we'll have special upgrading instructions from one version to the next.
Code of conduct
We will behave ourselves if you behave yourselves. For more details see our
CODE_OF_CONDUCT.md.
Contributing
Please read through our contributing guidelines. Included
are directions for opening issues.
Versioning
Font Awesome will be maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered
with the following format:
<major>.<minor>.
For more information on SemVer, please visit https://semver.org.
The major version "7" is part of an umbrella release. It includes many different types of files and technologies. Therefore
we deviate from normal SemVer in the following ways:
- Any release may update the design, look-and-feel, or branding of an existing
icon - We will never intentionally release a
patchversion update that breaks
backward compatibility - A
minorrelease may include backward-incompatible changes but we will
write clear upgrading instructions in UPGRADING.md - A
minororpatchrelease will never remove icons - Bug fixes will be addressed as
patchreleases unless they include backward
incompatibility then they will beminorreleases
License
Font Awesome Free is free, open source, and GPL friendly. You can use it for
commercial projects, open source projects, or really almost whatever you want.
- Icons — CC BY 4.0 License
- In the Font Awesome Free download, the CC BY 4.0 license applies to all icons packaged as .svg and .js files types.
- Fonts — SIL OFL 1.1 License
- In the Font Awesome Free download, the SIL OFL license applies to all icons packaged as web and desktop font files.
- Code — MIT License
- In the Font Awesome Free download, the MIT license applies to all non-font and non-icon files.
Attribution is required by MIT, SIL OFL, and CC BY licenses. Downloaded Font
Awesome Free files already contain embedded comments with sufficient
attribution, so you shouldn't need to do anything additional when using these
files normally.
We've kept attribution comments terse, so we ask that you do not actively work
to remove them from files, especially code. They're a great way for folks to
learn about Font Awesome.
Team
https://github.com/orgs/FortAwesome/people
File: js-packages/@fortawesome/free-solid-svg-icons/README.md
@fortawesome/free-solid-svg-icons - SVG with JavaScript version
"I came here to chew bubblegum and install Font Awesome 5 - and I'm all out of bubblegum"
Installation
$ npm i --save @fortawesome/free-solid-svg-iconsOr
$ yarn add @fortawesome/free-solid-svg-iconsDocumentation
Get started here. Continue your journey here.
Or go straight to the API documentation.
Issues and support
Start with GitHub issues and ping us on Twitter if you need to.
File: js-packages/@fortawesome/free-regular-svg-icons/README.md
@fortawesome/free-regular-svg-icons - SVG with JavaScript version
"I came here to chew bubblegum and install Font Awesome 5 - and I'm all out of bubblegum"
Installation
$ npm i --save @fortawesome/free-regular-svg-iconsOr
$ yarn add @fortawesome/free-regular-svg-iconsDocumentation
Get started here. Continue your journey here.
Or go straight to the API documentation.
Issues and support
Start with GitHub issues and ping us on Twitter if you need to.
File: js-packages/@fortawesome/free-brands-svg-icons/README.md
@fortawesome/free-brands-svg-icons - SVG with JavaScript version
"I came here to chew bubblegum and install Font Awesome 5 - and I'm all out of bubblegum"
Installation
$ npm i --save @fortawesome/free-brands-svg-iconsOr
$ yarn add @fortawesome/free-brands-svg-iconsDocumentation
Get started here. Continue your journey here.
Or go straight to the API documentation.
Issues and support
Start with GitHub issues and ping us on Twitter if you need to.
File: js-packages/@fortawesome/fontawesome-svg-core/README.md
@fortawesome/fontawesome-svg-core - SVG with JavaScript version
"I came here to chew bubblegum and install Font Awesome 7 - and I'm all out of bubblegum"
Installation
$ npm i --save @fortawesome/fontawesome-svg-coreOr
$ yarn add @fortawesome/fontawesome-svg-coreDocumentation
Get started here. Continue your journey here.
Or go straight to the API documentation.
Issues and support
Start with GitHub issues and ping us on Twitter if you need to.
File: js-packages/@fortawesome/fontawesome-free/README.md
@fortawesome/fontawesome-free - The Official Font Awesome 7 NPM package
"I came here to chew bubblegum and install Font Awesome 7 - and I'm all out of bubblegum"
Installation
$ npm i --save @fortawesome/fontawesome-freeOr
$ yarn add @fortawesome/fontawesome-freeWhat's included?
This package includes all the same files available through our Free and Pro CDN.
- /js - All JavaScript files associated with Font Awesome 7 SVG with JS
- /css - All CSS using the classic Web Fonts with CSS implementation
- /sprites - SVG icons packaged in a convenient sprite
- /scss - 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. Continue your journey here.
Or go straight to the API documentation.
Issues and support
Start with GitHub issues and ping us on Twitter if you need to.
File: js-packages/@fortawesome/fontawesome-common-types/README.md
@fortawesome/fontawesome-common-types - SVG with JavaScript
"I came here to chew bubblegum and install Font Awesome 7 - and I'm all out of bubblegum"
What is this package?
Font Awesome 7 JavaScript packages support TypeScript. This package abstracts out some of the common definitions that those packages use.
Here be dragons
If you are trying to import types from this package we highly recommend you do the following instead as all types in this package are re-exported to the main fontawesome package.
your.ts
import {
IconName
} from `@fortawesome/fontawesome-svg-core`
const myIcon: IconName = "..."Issues and support
Start with GitHub issues and ping us on Twitter if you need to.
File: otfs/README.md
A HEADS UP ABOUT DUOTONE ICONS ON THE DESKTOP
Duotone icons are a bit different to use than other Font Awesome icons at the moment.
We currently recommend using the Duotone-specific optimized .svg vector
files. These can be found in the /svgs/duotone folder of this download.Using Ligatures with Duotone Icons is NOT currently recommended - while we've
included a Duotone ligature-based font file in our Pro desktop download, we
can't recommend it as a way to use our icons on the desktop. Read the special
instructions for using duotones with ligatures here -
https://fontawesome.com/how-to-use/on-the-desktop/referencing-icons/duotone-icons#using-ligatures.
You can read the nitty gritty on the current limitations desktop apps have that
made our Duotone ligature implementation diferent there as well. And our full
Duotone Desktop docs are available at:
https://fontawesome.com/how-to-use/on-the-desktop/referencing-icons/duotone-icons.