Fork-Awesome/3.2.1/get-started/index.html
2016-10-24 12:01:53 -04:00

309 lines
16 KiB
HTML

<!DOCTYPE html>
<!--[if lt IE 7 ]><html class="ie ie6" lang="en"> <![endif]-->
<!--[if IE 7 ]><html class="ie ie7" lang="en"> <![endif]-->
<!--[if IE 8 ]><html class="ie ie8" lang="en"> <![endif]-->
<!--[if (gte IE 9)|!(IE)]><!-->
<html lang="en" xmlns="http://www.w3.org/1999/html"> <!--<![endif]-->
<head>
<!-- Basic Page Needs
================================================== -->
<meta charset="utf-8" />
<title>Get Started with Font Awesome</title>
<meta name="description" content="Font Awesome, the iconic font designed for Bootstrap">
<meta name="author" content="Dave Gandy">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!--<meta name="viewport" content="initial-scale=1; maximum-scale=1">-->
<!--[if lt IE 9]>
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<!-- CSS
================================================== -->
<link rel="stylesheet" href="../assets/css/site.css">
<link rel="stylesheet" href="../assets/css/pygments.css">
<link rel="stylesheet" href="../assets/font-awesome/css/font-awesome.css">
<!--[if IE 7]>
<link rel="stylesheet" href="../assets/font-awesome/css/font-awesome-ie7.css">
<![endif]-->
<!-- Le fav and touch icons -->
<link rel="shortcut icon" href="../assets/ico/favicon.ico">
<script type="text/javascript" src="//use.typekit.net/wnc7ioh.js"></script>
<script type="text/javascript">try{Typekit.load();}catch(e){}</script>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-30136587-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body data-spy="scroll" data-target=".navbar">
<div class="wrapper"> <!-- necessary for sticky footer. wrap all content except footer -->
<div class="navbar navbar-inverse navbar-static-top hidden-print">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<a class="brand" href="../"><i class="icon-flag"></i> Font Awesome</a>
<div class="nav-collapse collapse">
<ul class="nav">
<li class="hidden-tablet "><a href="../">Home</a></li>
<li class="active"><a href="../get-started/">Get Started</a></li>
<li class="dropdown-split-left"><a href="../icons/">Icons</a></li>
<li class="dropdown dropdown-split-right hidden-phone">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
<i class="icon-caret-down"></i>
</a>
<ul class="dropdown-menu pull-right">
<li><a href="../icons/"><i class="icon-flag icon-fixed-width"></i>&nbsp; Icons</a></li>
<li class="divider"></li>
<li><a href="../icons/#new"><i class="icon-shield icon-fixed-width"></i>&nbsp; New Icons in 3.2.1</a></li>
<li><a href="../icons/#web-application"><i class="icon-camera-retro icon-fixed-width"></i>&nbsp; Web Application Icons</a></li>
<li><a href="../icons/#currency"><i class="icon-won icon-fixed-width"></i>&nbsp; Currency Icons</a></li>
<li><a href="../icons/#text-editor"><i class="icon-file-text-alt icon-fixed-width"></i>&nbsp; Text Editor Icons</a></li>
<li><a href="../icons/#directional"><i class="icon-hand-right icon-fixed-width"></i>&nbsp; Directional Icons</a></li>
<li><a href="../icons/#video-player"><i class="icon-play-sign icon-fixed-width"></i>&nbsp; Video Player Icons</a></li>
<li><a href="../icons/#brand"><i class="icon-github icon-fixed-width"></i>&nbsp; Brand Icons</a></li>
<li><a href="../icons/#medical"><i class="icon-medkit icon-fixed-width"></i>&nbsp; Medical Icons</a></li>
</ul>
</li>
<li class="dropdown-split-left"><a href="../examples/">Examples</a></li>
<li class="dropdown dropdown-split-right hidden-phone">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
<i class="icon-caret-down"></i>
</a>
<ul class="dropdown-menu pull-right">
<li><a href="../examples/">Examples</a></li>
<li class="divider"></li>
<li><a href="../examples/#new-styles">New Styles</a></li>
<li><a href="../examples/#inline-icons">Inline Icons</a></li>
<li><a href="../examples/#larger-icons">Larger Icons</a></li>
<li><a href="../examples/#bordered-pulled">Bordered & Pulled</a></li>
<li><a href="../examples/#buttons">Buttons</a></li>
<li><a href="../examples/#button-groups">Button Groups</a></li>
<li><a href="../examples/#button-dropdowns">Button Dropdowns</a></li>
<li><a href="../examples/#bulleted-lists">Bulleted Lists</a></li>
<li><a href="../examples/#navigation">Navigation</a></li>
<li><a href="../examples/#form-inputs">Form Inputs</a></li>
<li><a href="../examples/#animated-spinner">Animated Spinner</a></li>
<li><a href="../examples/#rotated-flipped">Rotated &amp; Flipped</a></li>
<li><a href="../examples/#stacked">Stacked</a></li>
<li><a href="../examples/#custom">Custom CSS</a></li>
</ul>
</li>
<li><a href="../whats-new/">
<span class="hidden-tablet">What's </span>New</a>
</li>
<li><a href="../community/">Community</a></li>
<li><a href="../license/">License</a></li>
</ul>
<ul class="nav pull-right">
<li><a href="http://articles.fortawesome.com">Blog</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="jumbotron jumbotron-ad hidden-print">
<div class="container">
<h1><i class="icon-cogs icon-large"></i>&nbsp; Get Started</h1>
<p>Easy ways to get Font Awesome 3.2.1 onto your website</p>
</div>
</div>
<div id="social-buttons" class="hidden-print">
<div class="container">
<ul class="unstyled inline">
<li>
<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>
</li>
<li>
<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>
</li>
<li class="follow-btn">
<a href="https://twitter.com/fontawesome" class="twitter-follow-button" data-link-color="#0069D6" data-show-count="true">Follow @fontawesome</a>
</li>
<li class="tweet-btn hidden-phone">
<a href="https://twitter.com/share" class="twitter-share-button" data-url="http://fontawesome.io" data-text="Font Awesome, the iconic font designed for Bootstrap" data-counturl="http://fortawesome.github.com/Font-Awesome/" data-count="horizontal" data-via="fontawesome" data-related="davegandy:Creator of Font Awesome">Tweet</a>
</li>
</ul>
</div>
</div>
<div class="container">
<section class="old-docs">
<div class="row">
<div class="span12">
<div class="alert alert-danger">
<strong>Heads up!</strong> These docs are for v3.2.1, which is no longer officially supported. <a href="../../">Check out the latest version of Font Awesome!</a>
</div>
</div>
</div>
</section>
<section class="hidden-print">
<div class="row stripe-ad">
<div class="span8">
<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="http://getbootstrap.com">Bootstrap</a>!
</p>
</div>
<div class="span4">
<div id="carbonads-container"><div class="carbonad"><div id="azcarbon"></div><script type="text/javascript">var z = document.createElement("script"); z.type = "text/javascript"; z.async = true; z.src = "http://engine.carbonads.com/z/32291/azcarbon_2_1_0_HORIZ"; var s = document.getElementsByTagName("script")[0]; s.parentNode.insertBefore(z, s);</script></div></div>
</div>
</div>
</section>
<div id="bootstrapcdn">
<h2 class="page-header">EASIEST: <a href="http://www.bootstrapcdn.com/#tab_fontawesome">BootstrapCDN</a></h2>
<p>Add Font Awesome + Bootstrap into your website with two lines 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.
<div class="highlight"><pre><code class="html"><span class="nt">&lt;link</span> <span class="na">href=</span><span class="s">&quot;//netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap-combined.no-icons.min.css&quot;</span> <span class="na">rel=</span><span class="s">&quot;stylesheet&quot;</span><span class="nt">&gt;</span>
<span class="nt">&lt;link</span> <span class="na">href=</span><span class="s">&quot;//netdna.bootstrapcdn.com/font-awesome/3.2.1/css/font-awesome.css&quot;</span> <span class="na">rel=</span><span class="s">&quot;stylesheet&quot;</span><span class="nt">&gt;</span>
</code></pre></div>
<div class="alert alert-info margin-top">
<i class="icon-info-sign"></i> Want to use Font Awesome by itself without Bootstrap? Just don't include the first line.
</div>
</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 two lines of code.
</li>
<li>
Check out the <a href="../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 <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.
<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/bootstrap/css/bootstrap.min.css&quot;</span><span class="nt">&gt;</span>
<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>
</code></pre></div>
</li>
<li>Check out the <a href="../examples/">examples</a> to start using Font Awesome!</li>
</ol>
</section>
<section id="custom-less">
<h2 class="page-header">PRO: Custom LESS</h2>
<p>Use this method to customize Font Awesome and Bootstrap 2.3.2 using LESS.</p>
<ol>
<li>Copy the <code>font-awesome</code> directory into your project.</li>
<li>Open your project's bootstrap/bootstrap.less and replace
<div class="highlight"><pre><code class="html">@import &quot;sprites.less&quot;;
</code></pre></div>
with
<div class="highlight"><pre><code class="html">@import &quot;path/to/font-awesome/less/font-awesome.less&quot;;
</code></pre></div>
</li>
<li>
Open your project's font-awesome/variables.less and edit the <code>@FontAwesomePath</code> variable to point to your font directory.
<div class="highlight"><pre><code class="html">@FontAwesomePath: &quot;../font&quot;;
</code></pre></div>
<p class="alert alert-info"><i class="icon-info-sign"></i> The font path is relative from your compiled CSS directory.</p>
</li>
<li>Re-compile your LESS if using a static compiler. Otherwise, you should be good to go.</li>
<li>Check out the <a href="../examples/">examples</a> to start using Font Awesome!</li>
</ol>
</section>
<section id="not-using-bootstrap">
<h2 class="page-header">Not using Bootstrap?</h2>
<p>Font Awesome works just as well without Bootstrap.</p>
<ol>
<li>Copy the <code>font-awesome</code> directory into your project.</li>
<li>Follow the above directions and skip the Bootstrap parts.</li>
<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>
<li>Check out the <a href="../examples/">examples</a> to start using Font Awesome!</li>
</ol>
</section>
<section id="need-ie7">
<h2 class="page-header">Need IE7 Support?</h2>
<p>Font Awesome supports IE7. If you need it, you have my condolences.</p>
<ol>
<li>Get Font Awesome working properly in a modern browser.</li>
<li>Copy font-awesome-ie7.min.css into your project.</li>
<li>
In the <code>&lt;head&gt;</code> of your html, reference the location to your font-awesome-ie7.min.css.
<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/bootstrap/css/bootstrap.min.css&quot;</span><span class="nt">&gt;</span>
<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>
<span class="c">&lt;!--[if IE 7]&gt;</span>
<span class="c"> &lt;link rel=&quot;stylesheet&quot; href=&quot;path/to/font-awesome/css/font-awesome-ie7.min.css&quot;&gt;</span>
<span class="c">&lt;![endif]--&gt;</span>
</code></pre></div>
</li>
<li>Go complain to whoever decided your project needs IE7 support.</li>
</ol>
</section>
</div>
<div class="push"><!-- necessary for sticky footer --></div>
</div>
<footer class="footer hidden-print">
<div class="container text-center">
<div>
<i class="icon-flag"></i> Font Awesome 3.2.1
<span class="hidden-phone">&middot;</span><br class="visible-phone">
Created and Maintained by <a href="http://twitter.com/davegandy">Dave Gandy</a>
</div>
<div>
Font Awesome licensed under <a href="http://scripts.sil.org/OFL">SIL OFL 1.1</a>
<span class="hidden-phone">&middot;</span><br class="visible-phone">
Code licensed under <a href="http://opensource.org/licenses/mit-license.html">MIT License</a>
<span class="hidden-phone hidden-tablet">&middot;</span><br class="visible-phone visible-tablet">
Documentation licensed under <a href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>
</div>
<div>
Thanks to <a href="http://tracking.maxcdn.com/c/148092/3982/378"><i class="icon-maxcdn"></i> MaxCDN</a> for providing the excellent <a href="http://www.bootstrapcdn.com/#tab_fontawesome">BootstrapCDN for Font Awesome</a>
</div>
<div class="project">
<a href="https://github.com/FortAwesome/Font-Awesome">GitHub Project</a> &middot;
<a href="https://github.com/FortAwesome/Font-Awesome/issues">Issues</a>
</div>
</div>
</footer>
<script src="http://platform.twitter.com/widgets.js"></script>
<script src="../assets/js/jquery-1.7.1.min.js"></script>
<script src="../assets/js/ZeroClipboard-1.1.7.min.js"></script>
<script src="../assets/js/bootstrap-2.3.1.min.js"></script>
<script src="../assets/js/site.js"></script>
</body>
</html>