index.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <!-- Basic Page Needs
  5. ================================================== -->
  6. <meta charset="utf-8" />
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <meta name="description" content="Font Awesome, the iconic font and CSS framework">
  9. <meta name="author" content="Dave Gandy">
  10. <link rel="shortcut icon" href="../assets/ico/favicon.ico">
  11. <title>Get Started with Font Awesome</title>
  12. <!-- CSS
  13. ================================================== -->
  14. <link rel="stylesheet" href="../assets/css/site.css">
  15. <link rel="stylesheet" href="../assets/css/pygments.css">
  16. <link rel="stylesheet" href="../assets/font-awesome/css/font-awesome.css">
  17. <!--[if lt IE 9]>
  18. <script src="../assets/js/html5shiv.js"></script>
  19. <script src="../assets/js/respond.min.js"></script>
  20. <![endif]-->
  21. <script type="text/javascript" src="//use.typekit.net/wnc7ioh.js"></script>
  22. <script type="text/javascript">try{Typekit.load();}catch(e){}</script>
  23. <script type="text/javascript">
  24. var _gaq = _gaq || [];
  25. _gaq.push(['_setAccount', 'UA-30136587-1']);
  26. _gaq.push(['_trackPageview']);
  27. (function() {
  28. var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
  29. ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
  30. var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
  31. })();
  32. </script>
  33. </head>
  34. <body>
  35. <div id="wrap"> <!-- necessary for sticky footer. wrap all content except footer -->
  36. <div class="navbar navbar-inverse navbar-static-top hidden-print">
  37. <div class="container">
  38. <div class="navbar-header">
  39. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
  40. <span class="sr-only">Toggle navigation</span>
  41. <i class="fa fa-bars fa-lg"></i>
  42. </button>
  43. <a class="navbar-brand" href="../"><i class="fa fa-flag"></i> Font Awesome</a>
  44. </div>
  45. <div class="navbar-collapse collapse">
  46. <ul class="nav navbar-nav">
  47. <li class="hidden-sm "><a href="../">Home</a></li>
  48. <li class="hidden-sm">
  49. <a href="../whats-new/">What's New</a>
  50. </li>
  51. <li class="hidden-xs hidden-md hidden-lg">
  52. <a href="../whats-new/">New</a>
  53. </li>
  54. <li class="active"><a href="../get-started/">Get Started</a></li>
  55. <li class="dropdown-split-left"><a href="../icons/">Icons</a></li>
  56. <li class="dropdown dropdown-split-right hidden-xs">
  57. <a href="#" class="dropdown-toggle" data-toggle="dropdown">
  58. <i class="fa fa-caret-down"></i>
  59. </a>
  60. <ul class="dropdown-menu pull-right">
  61. <li><a href="../icons/"><i class="fa fa-flag fa-fw"></i>&nbsp; Icons</a></li>
  62. <li class="divider"></li>
  63. <li><a href="../icons/#new"><i class="fa fa-cube fa-fw"></i>&nbsp; New Icons in 4.1</a></li>
  64. <li><a href="../icons/#web-application"><i class="fa fa-camera-retro fa-fw"></i>&nbsp; Web Application Icons</a></li>
  65. <li><a href="../icons/#file-type"><i class="fa fa-file-image-o fa-fw"></i>&nbsp; File Type Icons</a></li>
  66. <li><a href="../icons/#spinner"><i class="fa fa-spinner fa-fw"></i>&nbsp; Spinner Icons</a></li>
  67. <li><a href="../icons/#form-control"><i class="fa fa-check-square fa-fw"></i>&nbsp; Form Control Icons</a></li>
  68. <li><a href="../icons/#currency"><i class="fa fa-won fa-fw"></i>&nbsp; Currency Icons</a></li>
  69. <li><a href="../icons/#text-editor"><i class="fa fa-file-text-o fa-fw"></i>&nbsp; Text Editor Icons</a></li>
  70. <li><a href="../icons/#directional"><i class="fa fa-hand-o-right fa-fw"></i>&nbsp; Directional Icons</a></li>
  71. <li><a href="../icons/#video-player"><i class="fa fa-play-circle fa-fw"></i>&nbsp; Video Player Icons</a></li>
  72. <li><a href="../icons/#brand"><i class="fa fa-github fa-fw"></i>&nbsp; Brand Icons</a></li>
  73. <li><a href="../icons/#medical"><i class="fa fa-medkit fa-fw"></i>&nbsp; Medical Icons</a></li>
  74. </ul>
  75. </li>
  76. <li class="dropdown-split-left"><a href="../examples/">Examples</a></li>
  77. <li class="dropdown dropdown-split-right hidden-xs">
  78. <a href="#" class="dropdown-toggle" data-toggle="dropdown">
  79. <i class="fa fa-caret-down"></i>
  80. </a>
  81. <ul class="dropdown-menu pull-right">
  82. <li><a href="../examples/">Examples</a></li>
  83. <li class="divider"></li>
  84. <li><a href="../examples/#basic">Basic Icons</a></li>
  85. <li><a href="../examples/#larger">Larger Icons</a></li>
  86. <li><a href="../examples/#fixed-width">Fixed Width Icons</a></li>
  87. <li><a href="../examples/#list">List Icons</a></li>
  88. <li><a href="../examples/#bordered-pulled">Bordered & Pulled Icons</a></li>
  89. <li><a href="../examples/#spinning">Spinning Icons</a></li>
  90. <li><a href="../examples/#rotated-flipped">Rotated &amp; Flipped Icons</a></li>
  91. <li><a href="../examples/#stacked">Stacked Icons</a></li>
  92. <li><a href="../examples/#bootstrap">Bootstrap 3 Examples</a></li>
  93. <li><a href="../examples/#custom">Custom CSS</a></li>
  94. </ul>
  95. </li>
  96. <li><a href="../community/">Community</a></li>
  97. <li><a href="../license/">License</a></li>
  98. </ul>
  99. <ul class="nav navbar-nav navbar-right">
  100. <li><a href="http://blog.fontawesome.io">Blog</a></li>
  101. </ul>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="jumbotron jumbotron-ad hidden-print">
  106. <div class="container">
  107. <h1><i class="fa fa-cogs"></i>&nbsp; Get Started</h1>
  108. <p>Easy ways to get Font Awesome 4.1.0 onto your website</p>
  109. </div>
  110. </div>
  111. <div id="social-buttons" class="hidden-print">
  112. <div class="container">
  113. <ul class="list-inline">
  114. <li>
  115. <iframe class="github-btn" src="http://ghbtns.com/github-btn.html?user=FortAwesome&repo=Font-Awesome&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100px" height="20px"></iframe>
  116. </li>
  117. <li>
  118. <iframe class="github-btn" src="http://ghbtns.com/github-btn.html?user=FortAwesome&repo=Font-Awesome&type=fork&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="102px" height="20px"></iframe>
  119. </li>
  120. <li class="follow-btn">
  121. <a href="https://twitter.com/fontawesome" class="twitter-follow-button" data-link-color="#0069D6" data-show-count="true">Follow @fontawesome</a>
  122. </li>
  123. <li class="tweet-btn hidden-phone">
  124. <a href="https://twitter.com/share" class="twitter-share-button" data-url="http://fontawesome.io" data-text="Font Awesome, the iconic font and CSS framework" data-counturl="http://fortawesome.github.com/Font-Awesome/" data-count="horizontal" data-via="fontawesome" data-related="davegandy:Creator of Font Awesome">Tweet</a>
  125. </li>
  126. </ul>
  127. </div>
  128. </div>
  129. <div class="container">
  130. <section class="hidden-print">
  131. <div class="stripe-ad">
  132. <script type="text/javascript" src="//cdn.fusionads.net/fusion.js?zoneid=1332&serve=C6SDP2Y&placement=fontawesome" id="_fusionads_js"></script>
  133. <p class="lead">
  134. Setting up Font Awesome can be as simple as adding two lines of code to your website, or you can be a pro and
  135. customize the LESS yourself! Font Awesome even plays nicely with
  136. <a href="http://getbootstrap.com">Bootstrap 3</a>!
  137. </p>
  138. </div>
  139. </section>
  140. <div id="bootstrapcdn">
  141. <h2 class="page-header">EASIEST: <a href="http://www.bootstrapcdn.com/#fontawesome_tab">BootstrapCDN</a> by <a href="http://maxcdn.com">MaxCDN</a></h2>
  142. <p>Thanks to the generous folks at <a href="http://maxcdn.com">MaxCDN</a>, you can use Bootstrap CDN to add Font Awesome into your website with a single line of code. You don't even have to download or install anything!</p>
  143. <ol>
  144. <li>
  145. Paste the following code into the <code>&lt;head&gt;</code> section of your site's HTML.
  146. <div class="highlight"><pre><code class="html"><span class="nt">&lt;link</span> <span class="na">href=</span><span class="s">&quot;//maxcdn.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.min.css&quot;</span> <span class="na">rel=</span><span class="s">&quot;stylesheet&quot;</span><span class="nt">&gt;</span>
  147. </code></pre></div>
  148. <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>
  149. </li>
  150. <li>
  151. Pat yourself on the back for your scalable-vector-icons-on-the-website
  152. <a href="http://37signals.com/svn/posts/312-lingo-judo">judo solution</a> in a single line of code.
  153. </li>
  154. <li>
  155. Check out the <a href="../examples/">examples</a> to start using Font Awesome!
  156. </li>
  157. </ol>
  158. </div>
  159. <section id="default-css">
  160. <h2 class="page-header">EASY: Default CSS</h2>
  161. <p>Use this method to get the default Font Awesome CSS with the default Bootstrap CSS.</p>
  162. <ol>
  163. <li>Copy the entire <code>font-awesome</code> directory into your project.</li>
  164. <li>
  165. In the <code>&lt;head&gt;</code> of your html, reference the location to your font-awesome.min.css.
  166. <div class="highlight"><pre><code class="html"><span class="nt">&lt;link</span> <span class="na">rel=</span><span class="s">&quot;stylesheet&quot;</span> <span class="na">href=</span><span class="s">&quot;path/to/font-awesome/css/font-awesome.min.css&quot;</span><span class="nt">&gt;</span>
  167. </code></pre></div>
  168. </li>
  169. <li>Check out the <a href="../examples/">examples</a> to start using Font Awesome!</li>
  170. </ol>
  171. </section>
  172. <section id="ruby-gem-less">
  173. <h2 class="page-header">EASY: <a href="https://github.com/FortAwesome/font-awesome-less">LESS Ruby Gem</a></h2>
  174. <p>
  175. Use the <a href="https://github.com/FortAwesome/font-awesome-less">Official Font Awesome LESS Ruby Gem</a> to easily get Font
  176. Awesome LESS into a Rails project. Generously maintained by <a href="https://twitter.com/supercodepoet/">@supercodepoet</a>.
  177. </p>
  178. <ol>
  179. <li>
  180. Add this line to your application's Gemfile:
  181. <div class="highlight"><pre><code class="bash">gem <span class="s1">&#39;font-awesome-less&#39;</span>
  182. </code></pre></div>
  183. </li>
  184. <li>
  185. And then execute:
  186. <div class="highlight"><pre><code class="bash"><span class="nv">$ </span>bundle
  187. </code></pre></div>
  188. </li>
  189. <li>Or install it yourself as:
  190. <div class="highlight"><pre><code class="bash"><span class="nv">$ </span>gem install font-awesome-less
  191. </code></pre></div>
  192. </li>
  193. </ol>
  194. </section>
  195. <section id="ruby-gem-sass">
  196. <h2 class="page-header">EASY: <a href="https://github.com/FortAwesome/font-awesome-sass">SASS Ruby Gem</a></h2>
  197. <p>
  198. Use the <a href="https://github.com/FortAwesome/font-awesome-sass">Official Font Awesome SASS Ruby Gem</a> to easily get Font
  199. Awesome SASS into a Rails project. Generously maintained by <a href="https://twitter.com/supercodepoet/">@supercodepoet</a>.
  200. </p>
  201. <ol>
  202. <li>
  203. Add this line to your application's Gemfile:
  204. <div class="highlight"><pre><code class="bash">gem <span class="s1">&#39;font-awesome-sass&#39;</span>
  205. </code></pre></div>
  206. </li>
  207. <li>
  208. And then execute:
  209. <div class="highlight"><pre><code class="bash"><span class="nv">$ </span>bundle
  210. </code></pre></div>
  211. </li>
  212. <li>Or install it yourself as:
  213. <div class="highlight"><pre><code class="bash"><span class="nv">$ </span>gem install font-awesome-sass
  214. </code></pre></div>
  215. </li>
  216. </ol>
  217. </section>
  218. <section id="custom-less">
  219. <h2 class="page-header">PRO: Custom LESS or SASS</h2>
  220. <p>Use this method to customize Font Awesome 4.1.0 using LESS or SASS.</p>
  221. <ol>
  222. <li>Copy the <code>font-awesome/</code> directory into your project.</li>
  223. <li>
  224. 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>
  225. variable to point to your font directory.
  226. <div class="highlight"><pre><code class="scss"><span class="k">@fa-font-path</span><span class="nd">:</span> <span class="s2">&quot;../font&quot;</span><span class="o">;</span>
  227. </code></pre></div>
  228. <p class="alert alert-success"><i class="fa fa-info-circle"></i> The font path is relative from your compiled CSS directory.</p>
  229. </li>
  230. <li>Re-compile your LESS or SASS if using a static compiler. Otherwise, you should be good to go.</li>
  231. <li>Check out the <a href="../examples/">examples</a> to start using Font Awesome!</li>
  232. </ol>
  233. </section>
  234. <section class="need-ie7">
  235. <h2 class="page-header">Need IE7 Support?</h2>
  236. <p>
  237. If you need IE7 support, you have my condolences. Really. Font Awesome 4.1.0
  238. doesn't support IE7, but an older version does. You'll need to check out the
  239. <a href="../3.2.1/get-started/#need-ie7">3.2.1 instructions for using IE7</a>. Then go complain to
  240. whomever decided your project needs IE7 support.
  241. </p>
  242. </section>
  243. <section id="troubleshooting">
  244. <h2 class="page-header">Troubleshooting</h2>
  245. <p>
  246. If you're having trouble with Font Awesome, make sure to check out the
  247. <a href="https://github.com/FortAwesome/Font-Awesome/wiki/Troubleshooting">troubleshooting wiki page</a>.
  248. Generously maintained by <a href="https://twitter.com/gtagliala">@gtagliala</a>.
  249. </p>
  250. </section>
  251. </div>
  252. </div>
  253. <footer id="footer" class="footer hidden-print">
  254. <div class="container text-center">
  255. <div>
  256. <i class="fa fa-flag"></i> Font Awesome 4.1.0
  257. <span class="hide-xs">&middot;</span><br class="hide-sm hide-md hide-lg">
  258. Created by <a href="http://twitter.com/davegandy">Dave Gandy</a>
  259. </div>
  260. <div>
  261. Font Awesome licensed under <a href="http://scripts.sil.org/OFL">SIL OFL 1.1</a>
  262. <span class="hide-xs">&middot;</span><br class="hide-sm hide-md hide-lg">
  263. Code licensed under <a href="http://opensource.org/licenses/mit-license.html">MIT License</a>
  264. <span class="hide-xs hide-sm">&middot;</span><br class="hide-md hide-lg">
  265. Documentation licensed under <a href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>
  266. </div>
  267. <div>
  268. Thanks to <a href="http://maxcdn.com"><i class="fa fa-maxcdn"></i> MaxCDN</a> for providing the excellent <a href="http://www.bootstrapcdn.com/#fontawesome_tab">BootstrapCDN for Font Awesome</a>
  269. </div>
  270. <div class="project">
  271. <a href="https://github.com/FortAwesome/Font-Awesome">GitHub Project</a> &middot;
  272. <a href="https://github.com/FortAwesome/Font-Awesome/issues">Issues</a> &middot;
  273. <a href="../3.2.1">Old 3.2.1 Docs</a>
  274. </div>
  275. </div>
  276. </footer>
  277. <script src="http://platform.twitter.com/widgets.js"></script>
  278. <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
  279. <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
  280. <script src="../assets/js/site.js"></script>
  281. </body>
  282. </html>