font-awesome-rails

the font-awesome font bundled as an asset for the rails asset pipeline

  • Owner: bokmann/font-awesome-rails
  • Platform:
  • License:: MIT License
  • Category::
  • Topic:
  • Like:
    0
      Compare:

Github stars Tracking Chart

font-awesome-rails

Gem Version
Build Status
Gem Downloads

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

Main metrics

Overview
Name With Ownerbokmann/font-awesome-rails
Primary LanguageHTML
Program languageRuby (Language Count: 6)
Platform
License:MIT License
所有者活动
Created At2012-03-08 02:06:59
Pushed At2025-01-03 00:20:46
Last Commit At2025-01-02 16:20:29
Release Count44
Last Release Namev4.7.0.9 (Posted on 2024-11-10 10:15:48)
First Release Namev0.1.0 (Posted on 2012-03-07 22:19:46)
用户参与
Stargazers Count1.9k
Watchers Count37
Fork Count240
Commits Count301
Has Issues Enabled
Issues Count148
Issue Open Count10
Pull Requests Count54
Pull Requests Open Count2
Pull Requests Close Count30
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private