https://github.com/bokmann/font-awesome-rails
the font-awesome font bundled as an asset for the rails asset pipeline
https://github.com/bokmann/font-awesome-rails
Keywords from Contributors
activerecord activejob mvc rubygems crash-reporting ruby-gem sidekiq error-monitoring sinatra dsl
Last synced: about 21 hours ago
JSON representation
Repository metadata
the font-awesome font bundled as an asset for the rails asset pipeline
- Host: GitHub
- URL: https://github.com/bokmann/font-awesome-rails
- Owner: bokmann
- License: mit
- Created: 2012-03-08T02:06:59.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2025-01-03T00:20:46.000Z (about 1 year ago)
- Last Synced: 2026-02-21T18:47:59.854Z (12 days ago)
- Language: HTML
- Homepage: http://fortawesome.github.com/Font-Awesome/
- Size: 4.51 MB
- Stars: 1,856
- Watchers: 35
- Forks: 239
- Open Issues: 12
- Releases: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
README.md
[!TIP]
For Font Awesome 5 or 6 support, please consider font-awesome-sass.
font-awesome-rails
font-awesome-rails provides the
Font-Awesome web fonts and
stylesheets as a Rails engine for use with the asset pipeline.
Installation
Add this to your Gemfile:
gem "font-awesome-rails"
and run bundle install.
Usage
In your application.css, include the css file:
/*
*= require font-awesome
*/
Then restart your webserver if it was previously running.
Congrats! You now have scalable vector icon support. Pick an icon and check out the
FontAwesome Examples.
Sass Support
If you prefer SCSS, add this to your
application.css.scss file:
@import "font-awesome";
If you use the
Sass indented syntax,
add this to your application.css.sass file:
@import font-awesome
Helpers
There are also some helpers (fa_icon and fa_stacked_icon) that make your
views icontastic!
fa_icon "camera-retro"
# => <i class="fa fa-camera-retro"></i>
fa_icon "camera-retro", text: "Take a photo"
# => <i class="fa fa-camera-retro"></i> Take a photo
fa_icon "chevron-right", text: "Get started", right: true
# => Get started <i class="fa fa-chevron-right"></i>
fa_icon "quote-left 4x", class: "text-muted pull-left"
# => <i class="fa fa-quote-left fa-4x text-muted pull-left"></i>
content_tag(:li, fa_icon("check li", text: "Bulleted list item"))
# => <li><i class="fa fa-check fa-li"></i> Bulleted list item</li>
fa_stacked_icon "twitter", base: "square-o"
# => <span class="fa-stack">
# => <i class="fa fa-square-o fa-stack-2x"></i>
# => <i class="fa fa-twitter fa-stack-1x"></i>
# => </span>
fa_stacked_icon "dollar inverse", base: "circle", class: "fa-5x"
# => <span class="fa-stack fa-5x">
# => <i class="fa fa-circle fa-stack-2x"></i>
# => <i class="fa fa-dollar fa-inverse fa-stack-1x"></i>
# => </span>
fa_stacked_icon "terminal inverse", base: "square", class: "pull-right", text: "Hi!"
# => <span class="fa-stack pull-right">
# => <i class="fa fa-square fa-stack-2x"></i>
# => <i class="fa fa-terminal fa-inverse fa-stack-1x"></i>
# => </span> Hi!
Misc
Rails engines
When building a Rails engine that includes font-awesome-rails as a dependency,
be sure to require "font-awesome-rails" somewhere during the initialization of
your engine. Otherwise, Rails will not automatically pick up the load path of
the font-awesome-rails assets and helpers (source 1, source 2, source 3).
Deploying to sub-folders
It is sometimes the case that deploying a Rails application to a production
environment requires the application to be hosted at a sub-folder on the server.
This may be the case, for example, if Apache HTTPD or Nginx is being used as a
front-end proxy server, with Rails handling only requests that come in to a sub-folder
such as http://example.com/myrailsapp. In this case, the
FontAwesome gem (and other asset-serving engines) needs to know the sub-folder,
otherwise you can experience a problem roughly described as "my app works
fine in development, but fails when I deploy
it".
To fix this, set the relative URL root for the application. In the
environment file for the deployed version of the app, for example
config/environments/production.rb,
set the config option action_controller.relative_url_root:
MyApp::Application.configure do
...
# set the relative root, because we're deploying to /myrailsapp
config.action_controller.relative_url_root = "/myrailsapp"
...
end
The default value of this variable is taken from ENV['RAILS_RELATIVE_URL_ROOT'],
so configuring the environment to define RAILS_RELATIVE_URL_ROOT is an alternative strategy.
In addition you need to indicate the subfolder when you precompile the assets:
RAILS_ENV=production bundle exec rake assets:precompile RAILS_RELATIVE_URL_ROOT=/myrailsapp
Rails 3.2
[!NOTE]
In Rails 3.2, make sure font-awesome-rails is outside the bundler asset
group so that these helpers are automatically loaded in production
environments.
Versioning
Versioning follows the core releases of Font-Awesome which follows Semantic
Versioning 2.0 as defined at http://semver.org. We will do our best not to
make any breaking changes until Font-Awesome core makes a major version bump.
License
- The Font Awesome font is
licensed under the SIL Open Font License. - Font Awesome CSS files are
licensed under the
MIT License. - The remainder of the font-awesome-rails project is licensed under the
MIT License.
Owner metadata
- Name: David Bock
- Login: bokmann
- Email:
- Kind: user
- Description: VP Strategic Development at Core4ce, Director of Loudoun Computer Science Initiative. I try to write code, teach, and learn something every day. He/Him.
- Website: http://LoudounCodes.org
- Location: Hamilton, VA
- Twitter: bokmann
- Company: @loudouncodes
- Icon url: https://avatars.githubusercontent.com/u/57926?u=8d289825120bede87cfc23bc16fe61b2d6898761&v=4
- Repositories: 46
- Last ynced at: 2023-04-16T05:35:23.717Z
- Profile URL: https://github.com/bokmann
GitHub Events
Total
- Release event: 1
- Delete event: 1
- Pull request event: 2
- Fork event: 1
- Issues event: 2
- Watch event: 16
- Issue comment event: 2
- Push event: 6
- Create event: 2
Last Year
- Watch event: 9
Committers metadata
Last synced: 2 days ago
Total Commits: 246
Total Committers: 34
Avg Commits per committer: 7.235
Development Distribution Score (DDS): 0.256
Commits in past year: 0
Committers in past year: 0
Avg Commits per committer in past year: 0.0
Development Distribution Score (DDS) in past year: 0.0
| Name | Commits | |
|---|---|---|
| Ryan McGeary | r****n@m****g | 183 |
| bokmann | d****k@c****m | 20 |
| Aditya Sanghi | a****i@m****m | 4 |
| Topher Fangio | f****a@g****m | 3 |
| Ian Dickinson | i****n@g****m | 3 |
| Chris Keele | d****v@c****m | 3 |
| David Southard | n****r@g****m | 2 |
| Markus Doits | m****s@s****e | 2 |
| change me to your name | c****l@e****m | 1 |
| Kai Schlichting | l****t@g****e | 1 |
| Adilson Carvalho | a****n@a****r | 1 |
| Adam Constabaris | a****s@n****u | 1 |
| Adam Constabaris | a****m | 1 |
| Aditya Sanghi | a****i@r****t | 1 |
| Alex Lau | M****u | 1 |
| Blair Anderson | b****1@g****m | 1 |
| Brian Racer | b****r@g****m | 1 |
| superscott | s****0@g****m | 1 |
| behrooz shabani (everplays) | e****s@g****m | 1 |
| barrywoolgar | b****y@s****m | 1 |
| Tony Summerville | t****e@r****m | 1 |
| Scott BonAmi | s****i@m****m | 1 |
| Richard Brown | r****b@o****g | 1 |
| Per Andersson | p****r@k****g | 1 |
| Noah Kantrowitz | n****h@c****t | 1 |
| Joshua Kovach | k****c@g****m | 1 |
| Joey Cody | j****y@g****m | 1 |
| Hector Correa | h****a@b****u | 1 |
| Harry Moreno | m****9@g****m | 1 |
| Franco Cravero Mendiburú | 8****f | 1 |
| and 4 more... | ||
Committer domains:
- me.com: 2
- imeos.com: 1
- brown.edu: 1
- coderanger.net: 1
- klenis.org: 1
- opensuse.org: 1
- rarestep.com: 1
- storm-consultancy.com: 1
- risingsuntech.net: 1
- ncsu.edu: 1
- adilsoncarvalho.com.br: 1
- gmx.de: 1
- stellenticket.de: 1
- chriskeele.com: 1
- codesherpas.com: 1
- mcgeary.org: 1
Issue and Pull Request metadata
Last synced: 9 days ago
Total issues: 68
Total pull requests: 36
Average time to close issues: 24 days
Average time to close pull requests: 25 days
Total issue authors: 66
Total pull request authors: 32
Average comments per issue: 5.46
Average comments per pull request: 1.47
Merged pull request: 20
Bot issues: 0
Bot pull requests: 0
Past year issues: 1
Past year pull requests: 1
Past year average time to close issues: about 3 hours
Past year average time to close pull requests: 7 minutes
Past year issue authors: 1
Past year pull request authors: 1
Past year average comments per issue: 0.0
Past year average comments per pull request: 0.0
Past year merged pull request: 1
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- rmm5t (2)
- ijdickinson (2)
- ttseng (1)
- AxelBriche (1)
- jasonfb (1)
- IslamAzab (1)
- marvindanig (1)
- david-a-wheeler (1)
- elrayle (1)
- adjam (1)
- Siplicity14 (1)
- camilova (1)
- derrickmar (1)
- SurajShukla (1)
- ankitsinghaniyaz (1)
Top Pull Request Authors
- rmm5t (5)
- jasonfb (2)
- washu (1)
- franco-cf (1)
- coreymartella (1)
- olejrosendahl (1)
- snecklifter (1)
- btorode (1)
- sysrich (1)
- MrAlexLau (1)
- eitoball (1)
- anveo (1)
- cseelus (1)
- ghost (1)
- deepakmahakale (1)
Top Issue Labels
- invalid (3)
Top Pull Request Labels
Package metadata
- Total packages: 12
-
Total downloads:
- rubygems: 121,257,958 total
- Total docker downloads: 36,310,610
- Total dependent packages: 244 (may contain duplicates)
- Total dependent repositories: 38,550 (may contain duplicates)
- Total versions: 104
- Total maintainers: 2
gem.coop: font-awesome-rails
font-awesome-rails provides the Font-Awesome web fonts and stylesheets as a Rails engine for use with the asset pipeline.
- Homepage: https://github.com/bokmann/font-awesome-rails
- Documentation: http://www.rubydoc.info/gems/font-awesome-rails/
- Licenses: MIT,SIL Open Font License
- Latest release: 0.5.0 (published about 13 years ago)
- Last Synced: 2026-03-03T17:01:44.396Z (1 day ago)
- Versions: 44
- Dependent Packages: 0
- Dependent Repositories: 0
- Downloads: 60,628,979 Total
- Docker Downloads: 18,155,305
-
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 0.367%
- Downloads: 0.455%
- Docker downloads count: 1.012%
- Maintainers (2)
rubygems.org: font-awesome-rails
font-awesome-rails provides the Font-Awesome web fonts and stylesheets as a Rails engine for use with the asset pipeline.
- Homepage: https://github.com/bokmann/font-awesome-rails
- Documentation: http://www.rubydoc.info/gems/font-awesome-rails/
- Licenses: MIT,SIL Open Font License
- Latest release: 0.5.0 (published about 13 years ago)
- Last Synced: 2026-03-03T17:30:41.748Z (1 day ago)
- Versions: 44
- Dependent Packages: 244
- Dependent Repositories: 38,550
- Downloads: 60,628,979 Total
- Docker Downloads: 18,155,305
-
Rankings:
- Dependent packages count: 0.163%
- Dependent repos count: 0.168%
- Downloads: 0.408%
- Average: 0.791%
- Docker downloads count: 1.083%
- Stargazers count: 1.195%
- Forks count: 1.731%
- Maintainers (2)
proxy.golang.org: github.com/bokmann/font-awesome-rails
- Homepage:
- Documentation: https://pkg.go.dev/github.com/bokmann/font-awesome-rails#section-documentation
- Licenses: mit
- Latest release: v0.5.0 (published about 13 years ago)
- Last Synced: 2026-03-02T12:01:41.068Z (3 days ago)
- Versions: 7
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Stargazers count: 1.559%
- Forks count: 1.777%
- Average: 5.928%
- Dependent packages count: 9.576%
- Dependent repos count: 10.802%
debian-10: ruby-font-awesome-rails
- Homepage: https://github.com/bokmann/font-awesome-rails
- Documentation: https://packages.debian.org/buster/ruby-font-awesome-rails
- Licenses:
- Latest release: 4.7.0.4-1 (published 22 days ago)
- Last Synced: 2026-02-13T04:21:26.188Z (20 days ago)
- Versions: 1
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 100%
ubuntu-23.10: ruby-font-awesome-rails
- Homepage: https://github.com/bokmann/font-awesome-rails
- Licenses:
- Latest release: 4.7.0.7-1 (published 20 days ago)
- Last Synced: 2026-02-13T18:20:44.585Z (20 days ago)
- Versions: 1
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 100%
ubuntu-23.04: ruby-font-awesome-rails
- Homepage: https://github.com/bokmann/font-awesome-rails
- Licenses:
- Latest release: 4.7.0.7-1 (published 22 days ago)
- Last Synced: 2026-02-11T06:39:39.806Z (22 days ago)
- Versions: 1
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 100%
debian-11: ruby-font-awesome-rails
- Homepage: https://github.com/bokmann/font-awesome-rails
- Documentation: https://packages.debian.org/bullseye/ruby-font-awesome-rails
- Licenses:
- Latest release: 4.7.0.7-1 (published 22 days ago)
- Last Synced: 2026-02-13T08:20:26.675Z (20 days ago)
- Versions: 1
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 100%
ubuntu-20.04: ruby-font-awesome-rails
- Homepage: https://github.com/bokmann/font-awesome-rails
- Licenses:
- Latest release: 4.7.0.5-1 (published 20 days ago)
- Last Synced: 2026-02-13T07:14:01.475Z (20 days ago)
- Versions: 1
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 100%
debian-12: ruby-font-awesome-rails
- Homepage: https://github.com/bokmann/font-awesome-rails
- Documentation: https://packages.debian.org/bookworm/ruby-font-awesome-rails
- Licenses:
- Latest release: 4.7.0.7-1 (published 20 days ago)
- Last Synced: 2026-02-12T23:29:50.852Z (20 days ago)
- Versions: 1
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 100%
ubuntu-22.04: ruby-font-awesome-rails
- Homepage: https://github.com/bokmann/font-awesome-rails
- Licenses:
- Latest release: 4.7.0.7-1 (published 20 days ago)
- Last Synced: 2026-02-13T13:17:19.747Z (20 days ago)
- Versions: 1
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 100%
Dependencies
- guard >= 2.9 development
- guard-minitest >= 0 development
- activesupport >= 0 development
- sassc-rails >= 0 development
- railties >= 3.2, < 8.0
- actions/checkout v4 composite
- ruby/setup-ruby v1 composite
Score: 29.934602745667668