3 title: Get Started with Font Awesome
4 navbar_active: get-started
7 {% capture jumbotron_h1 %}<i class="fa fa-cogs"></i> Get Started{% endcapture %}
8 {% capture jumbotron_p %}Easy ways to get Font Awesome {{ site.fontawesome.version }} onto your website{% endcapture %}
10 {% include jumbotron.html %}
11 {% include stripe-social.html %}
13 <div class="container">
14 {% capture stripe_ad_content %}
16 Setting up Font Awesome can be as simple as adding two lines of code to your website, or you can be a pro and
17 customize the LESS yourself! Font Awesome even plays nicely with
18 <a href="{{ site.bootstrap.url }}">Bootstrap 3</a>!
21 {% include stripe-ad.html %}
23 <div id="bootstrapcdn">
24 <h2 class="page-header">EASIEST: <a href="http://www.bootstrapcdn.com/#tab_fontawesome">BootstrapCDN</a></h2>
25 <p>Add Font Awesome into your website with a single line of code. You don't even have to download or install anything!</p>
28 Paste the following code into the <code><head></code> section of your site's HTML.
30 <link href="//netdna.bootstrapcdn.com/font-awesome/{{ site.fontawesome.version }}/css/font-awesome.css" rel="stylesheet">
32 <p class="alert alert-success"><i class="fa fa-info-circle"></i> Immediately after release, it takes a bit of time for BootstrapCDN to catch up and get the newest version live on their CDN.</p>
35 Pat yourself on the back for your scalable-vector-icons-on-the-website
36 <a href="http://37signals.com/svn/posts/312-lingo-judo">judo solution</a> in a single line of code.
39 Check out the <a href="{{ page.relative_path }}examples/">examples</a> to start using Font Awesome!
44 <section id="default-css">
45 <h2 class="page-header">EASY: Default CSS</h2>
46 <p>Use this method to get the default Font Awesome CSS with the default Bootstrap CSS.</p>
48 <li>Copy the entire <code>font-awesome</code> directory into your project.</li>
50 In the <code><head></code> of your html, reference the location to your font-awesome.min.css.
52 <link rel="stylesheet" href="path/to/font-awesome/css/font-awesome.min.css">
55 <li>Check out the <a href="{{ page.relative_path }}examples/">examples</a> to start using Font Awesome!</li>
59 <section id="ruby-gem-less">
60 <h2 class="page-header">EASY: <a href="https://github.com/FortAwesome/font-awesome-less">LESS Ruby Gem</a></h2>
62 Use the <a href="https://github.com/FortAwesome/font-awesome-less">Official Font Awesome LESS Ruby Gem</a> to easily get Font
63 Awesome LESS into a Rails project. Generously maintained by <a href="https://twitter.com/supercodepoet/">@supercodepoet</a>.
67 Add this line to your application's Gemfile:
69 gem 'font-awesome-less'
78 <li>Or install it yourself as:
80 $ gem install font-awesome-less
86 <section id="ruby-gem-sass">
87 <h2 class="page-header">EASY: <a href="https://github.com/FortAwesome/font-awesome-sass">SASS Ruby Gem</a></h2>
89 Use the <a href="https://github.com/FortAwesome/font-awesome-sass">Official Font Awesome SASS Ruby Gem</a> to easily get Font
90 Awesome SASS into a Rails project. Generously maintained by <a href="https://twitter.com/supercodepoet/">@supercodepoet</a>.
94 Add this line to your application's Gemfile:
96 gem 'font-awesome-sass'
105 <li>Or install it yourself as:
107 $ gem install font-awesome-sass
113 <section id="custom-less">
114 <h2 class="page-header">PRO: Custom LESS or SASS</h2>
115 <p>Use this method to customize Font Awesome {{ site.fontawesome.version }} using LESS or SASS.</p>
117 <li>Copy the <code>font-awesome/</code> directory into your project.</li>
119 Open your project's <code>font-awesome/less/variables.less</code> or <code>font-awesome/scss/_variables.scss</code> and edit the <code>@fa-font-path</code> or <code>$fa-font-path</code>
120 variable to point to your font directory.
122 @fa-font-path: "../font";
124 <p class="alert alert-success"><i class="fa fa-info-circle"></i> The font path is relative from your compiled CSS directory.</p>
126 <li>Re-compile your LESS or SASS if using a static compiler. Otherwise, you should be good to go.</li>
127 <li>Check out the <a href="{{ page.relative_path }}examples/">examples</a> to start using Font Awesome!</li>
131 <section class="need-ie7">
132 <h2 class="page-header">Need IE7 Support?</h2>
134 If you need IE7 support, you have my condolences. Really. Font Awesome {{ site.fontawesome.version }}
135 doesn't support IE7, but an older version does. You'll need to check out the
136 <a href="{{ page.relative_path }}3.2.1/get-started/#need-ie7">3.2.1 instructions for using IE7</a>. Then go complain to
137 whomever decided your project needs IE7 support.
141 <section id="troubleshooting">
142 <h2 class="page-header">Troubleshooting</h2>
144 If you're having trouble with Font Awesome, make sure to check out the
145 <a href="{{ site.fontawesome.github.url }}/wiki/Troubleshooting">troubleshooting wiki page</a>.
146 Generously maintained by <a href="https://twitter.com/gtagliala">@gtagliala</a>.