Font-Awesome/src/get-started.html

---
layout: base
title: Get Started with Font Awesome
navbar_active: get-started
relative_path: ../
---
{% capture jumbotron_h1 %}<i class="fa fa-cogs"></i>&nbsp; Get Started{% endcapture %}
{% capture jumbotron_p %}Easy ways to get Font Awesome {{ site.fontawesome.version }} onto your website{% endcapture %}

{% include jumbotron.html %}
{% include stripe-social.html %}

<div class="container">
  {% capture stripe_ad_content %}
  <p class="lead">
    Setting up Font Awesome can be as simple as adding two lines of code to your website, or you can be a pro and
    customize the LESS yourself! Font Awesome even plays nicely with
    <a href="{{ site.bootstrap.url }}">Bootstrap 3</a>!
  </p>
  {% endcapture %}
  {% include stripe-ad.html %}

  <div id="bootstrapcdn">
    <h2 class="page-header">EASIEST: <a href="http://www.bootstrapcdn.com/#tab_fontawesome">BootstrapCDN</a></h2>
    <p>Add Font Awesome into your website with a single line of code. You don't even have to download or install anything!</p>
    <ol>
      <li>
        Paste the following code into the <code>&lt;head&gt;</code> section of your site's HTML.
{% highlight html %}
<link href="//netdna.bootstrapcdn.com/font-awesome/{{ site.fontawesome.version }}/css/font-awesome.css" rel="stylesheet">
{% endhighlight %}
      </li>
      <li>
        Pat yourself on the back for your scalable-vector-icons-on-the-website
        <a href="http://37signals.com/svn/posts/312-lingo-judo">judo solution</a> in a single line of code.
      </li>
      <li>
        Check out the <a href="{{ page.relative_path }}examples/">examples</a> to start using Font Awesome!
      </li>
    </ol>
  </div>

  <section id="default-css">
    <h2 class="page-header">EASY: Default CSS</h2>
    <p>Use this method to get the default Font Awesome CSS with the default Bootstrap CSS.</p>
    <ol>
      <li>Copy the entire <code>font-awesome</code> directory into your project.</li>
      <li>
        In the <code>&lt;head&gt;</code> of your html, reference the location to your font-awesome.min.css.
{% highlight html %}
<link rel="stylesheet" href="path/to/font-awesome/css/font-awesome.min.css">
{% endhighlight %}
      </li>
      <li>Check out the <a href="{{ page.relative_path }}examples/">examples</a> to start using Font Awesome!</li>
    </ol>
  </section>

  <section id="ruby-gem">
    <h2 class="page-header">EASY: <a href="https://github.com/FortAwesome/font-awesome-sass">Font Awesome Ruby Gem</a></h2>
    <p>
      Use the <a href="https://github.com/FortAwesome/font-awesome-sass">Official Font Awesome Ruby Gem</a> to easily get Font
      Awesome into a Rails project. Generously maintained by <a href="https://twitter.com/supercodepoet/">@supercodepoet</a>.
    </p>
    <ol>
      <li>
        Add this line to your application's Gemfile:
{% highlight bash %}
gem 'font-awesome-sass'
{% endhighlight %}
      </li>
      <li>
        And then execute:
{% highlight bash %}
$ bundle
{% endhighlight %}
      </li>
      <li>Or install it yourself as:
{% highlight bash %}
$ gem install font-awesome-sass
{% endhighlight %}
      </li>
    </ol>
  </section>

  <section id="custom-less">
    <h2 class="page-header">PRO: Custom LESS or SCSS</h2>
    <p>Use this method to customize Font Awesome {{ site.bootstrap.version }} using LESS or SCSS.</p>
    <ol>
      <li>Copy the <code>font-awesome/</code> directory into your project.</li>
      <li>
        Open your project's font-awesome/variables.less and edit the <code>@fa-font-path</code> or <code>$fa-font-path</code>
        variable to point to your font directory.
{% highlight scss %}
@fa-font-path:   "../font";
{% endhighlight %}
        <p class="alert alert-success"><i class="fa fa-info-circle"></i> The font path is relative from your compiled CSS directory.</p>
      </li>
      <li>Re-compile your LESS or SCSS if using a static compiler. Otherwise, you should be good to go.</li>
      <li>Check out the <a href="{{ page.relative_path }}examples/">examples</a> to start using Font Awesome!</li>
    </ol>
  </section>

  <section class="need-ie7">
    <h2 class="page-header">Need IE7 Support?</h2>
    <p>
      If you need IE7 support, you have my condolences. Really. Font Awesome {{ site.fontawesome.version }}
      doesn't support IE7, but an older version does. You'll need to check out the
      <a href="{{ page.relative_path }}3.2.1/get-started/#need-ie7">3.2.1 instructions for using IE7</a>. Then go complain to
      whomever decided your project needs IE7 support.
    </p>
  </section>
</div>