git.roojs.org Git - bootswatch/blob - bower_components/font-awesome/src/_includes/get-started.html

   1 {% capture stripe_ad_content %}
   2 <p class="lead">
   3   Setting up Font Awesome can be as simple as adding two lines of code to your website, or you can be a pro and
   4   customize the LESS yourself! Font Awesome even plays nicely with
   5   <a href="{{ site.bootstrap.url }}">Bootstrap</a>!
   6 </p>
   7 {% endcapture %}
   8 {% include stripe-ad.html %}
   9
  10 <div id="bootstrapcdn">
  11   <h2 class="page-header">EASIEST: <a href="http://www.bootstrapcdn.com/#tab_fontawesome">BootstrapCDN</a></h2>
  12   <p>Add Font Awesome + Bootstrap into your website with two lines of code. You don't even have to download or install anything!</p>
  13   <ol>
  14     <li>
  15       Paste the following code into the <code>&lt;head&gt;</code> section of your site's HTML.
  16 {% highlight html %}
  17 <link href="//netdna.bootstrapcdn.com/twitter-bootstrap/{{ site.bootstrap.version }}/css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
  18 <link href="//netdna.bootstrapcdn.com/font-awesome/{{ site.fontawesome.version }}/css/font-awesome.css" rel="stylesheet">
  19 {% endhighlight %}
  20       <div class="alert alert-info margin-top">
  21         <i class="icon-info-sign"></i> Want to use Font Awesome by itself without Bootstrap? Just don't include the first line.
  22       </div>
  23     </li>
  24     <li>
  25       Pat yourself on the back for your scalable-vector-icons-on-the-website
  26       <a href="http://37signals.com/svn/posts/312-lingo-judo">judo solution</a> in two lines of code.
  27     </li>
  28     <li>
  29       Check out the <a href="{{ page.relative_path }}examples/">examples</a> to start using Font Awesome!
  30     </li>
  31   </ol>
  32 </div>
  33
  34 <section id="default-css">
  35   <h2 class="page-header">EASY: Default CSS</h2>
  36   <p>Use this method to get the default Font Awesome CSS with the default Bootstrap CSS.</p>
  37   <ol>
  38     <li>Copy the <code>font-awesome</code> directory into your project.</li>
  39     <li>
  40       In the <code>&lt;head&gt;</code> of your html, reference the location to your font-awesome.min.css.
  41 {% highlight html %}
  42 <link rel="stylesheet" href="path/to/bootstrap/css/bootstrap.min.css">
  43 <link rel="stylesheet" href="path/to/font-awesome/css/font-awesome.min.css">
  44 {% endhighlight %}
  45     </li>
  46     <li>Check out the <a href="{{ page.relative_path }}examples/">examples</a> to start using Font Awesome!</li>
  47   </ol>
  48 </section>
  49
  50 <section id="custom-less">
  51   <h2 class="page-header">PRO: Custom LESS</h2>
  52   <p>Use this method to customize Font Awesome and Bootstrap {{ site.bootstrap.version }} using LESS.</p>
  53   <ol>
  54     <li>Copy the <code>font-awesome</code> directory into your project.</li>
  55     <li>Open your project's bootstrap/bootstrap.less and replace
  56 {% highlight html %}
  57 @import "sprites.less";
  58 {% endhighlight %}
  59       with
  60 {% highlight html %}
  61 @import "path/to/font-awesome/less/font-awesome.less";
  62 {% endhighlight %}
  63     </li>
  64     <li>
  65       Open your project's font-awesome/variables.less and edit the <code>@FontAwesomePath</code> variable to point to your font directory.
  66 {% highlight html %}
  67 @FontAwesomePath:   "../font";
  68 {% endhighlight %}
  69       <p class="alert alert-info"><i class="icon-info-sign"></i> The font path is relative from your compiled CSS directory.</p>
  70     </li>
  71     <li>Re-compile your LESS if using a static compiler. Otherwise, you should be good to go.</li>
  72     <li>Check out the <a href="{{ page.relative_path }}examples/">examples</a> to start using Font Awesome!</li>
  73   </ol>
  74 </section>
  75
  76 <section id="not-using-bootstrap">
  77   <h2 class="page-header">Not using Bootstrap?</h2>
  78   <p>Font Awesome works just as well without Bootstrap.</p>
  79   <ol>
  80     <li>Copy the <code>font-awesome</code> directory into your project.</li>
  81     <li>Follow the above directions and skip the Bootstrap parts.</li>
  82     <li>Open your project's font-awesome.less or font-awesome.min.css and edit the font location to point it to your font directory (see above examples).</li>
  83     <li>Check out the <a href="{{ page.relative_path }}examples/">examples</a> to start using Font Awesome!</li>
  84   </ol>
  85 </section>
  86
  87 <section class="need-ie7">
  88   <h2 class="page-header">Need IE7 Support?</h2>
  89   <p>Font Awesome supports IE7. If you need it, you have my condolences.</p>
  90   <ol>
  91     <li>Get Font Awesome working properly in a modern browser.</li>
  92     <li>Copy font-awesome-ie7.min.css into your project.</li>
  93     <li>
  94       In the <code>&lt;head&gt;</code> of your html, reference the location to your font-awesome-ie7.min.css.
  95 {% highlight html %}
  96 <link rel="stylesheet" href="path/to/bootstrap/css/bootstrap.min.css">
  97 <link rel="stylesheet" href="path/to/font-awesome/css/font-awesome.min.css">
  98 <!--[if IE 7]>
  99   <link rel="stylesheet" href="path/to/font-awesome/css/font-awesome-ie7.min.css">
 100 <![endif]-->
 101 {% endhighlight %}
 102     </li>
 103     <li>Go complain to whoever decided your project needs IE7 support.</li>
 104   </ol>
 105 </section>