Fork-Awesome/get-started/index.html
2013-10-23 11:12:39 -04:00

288 lines
14 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<!-- Basic Page Needs
================================================== -->
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="Font Awesome, the iconic font designed for Bootstrap">
<meta name="author" content="Dave Gandy">
<link rel="shortcut icon" href="../assets/ico/favicon.ico">
<title>Get Started with Font Awesome</title>
<!-- 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 lt IE 9]>
<script src="../assets/js/html5shiv.js"></script>
<script src="../assets/js/respond.min.js"></script>
<![endif]-->
<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>
<div id="wrap"> <!-- necessary for sticky footer. wrap all content except footer -->
<div class="navbar navbar-inverse navbar-static-top hidden-print">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<i class="fa fa-reorder fa-lg"></i>
</button>
<a class="navbar-brand" href="../"><i class="fa fa-flag"></i> Font Awesome</a>
</div>
<div class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li class="hidden-sm "><a href="../">Home</a></li>
<li class="hidden-sm">
<a href="../whats-new/">What's New</a>
</li>
<li class="hidden-xs hidden-md hidden-lg">
<a href="../whats-new/">New</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-xs">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
<i class="fa fa-caret-down"></i>
</a>
<ul class="dropdown-menu pull-right">
<li><a href="../icons/"><i class="fa fa-flag fa-fw"></i>&nbsp; Icons</a></li>
<li class="divider"></li>
<li><a href="../icons/#new"><i class="fa fa-rub fa-fw"></i>&nbsp; New Icons in 4.0</a></li>
<li><a href="../icons/#web-application"><i class="fa fa-camera-retro fa-fw"></i>&nbsp; Web Application Icons</a></li>
<li><a href="../icons/#form-control"><i class="fa fa-check-square fa-fw"></i>&nbsp; Form Control Icons</a></li>
<li><a href="../icons/#currency"><i class="fa fa-won fa-fw"></i>&nbsp; Currency Icons</a></li>
<li><a href="../icons/#text-editor"><i class="fa fa-file-text-o fa-fw"></i>&nbsp; Text Editor Icons</a></li>
<li><a href="../icons/#directional"><i class="fa fa-hand-o-right fa-fw"></i>&nbsp; Directional Icons</a></li>
<li><a href="../icons/#video-player"><i class="fa fa-play-circle fa-fw"></i>&nbsp; Video Player Icons</a></li>
<li><a href="../icons/#brand"><i class="fa fa-github fa-fw"></i>&nbsp; Brand Icons</a></li>
<li><a href="../icons/#medical"><i class="fa fa-medkit fa-fw"></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-xs">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
<i class="fa fa-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/#inline">Inline Icons</a></li>
<li><a href="../examples/#larger">Larger Icons</a></li>
<li><a href="../examples/#fixed-width">Fixed Width Icons</a></li>
<li><a href="../examples/#list">List Icons</a></li>
<li><a href="../examples/#bordered-pulled">Bordered & Pulled Icons</a></li>
<li><a href="../examples/#spinning">Spinning Icons</a></li>
<li><a href="../examples/#rotated-flipped">Rotated &amp; Flipped Icons</a></li>
<li><a href="../examples/#stacked">Stacked Icons</a></li>
<li><a href="../examples/#bootstrap">Bootstrap 3 Examples</a></li>
<li><a href="../examples/#custom">Custom CSS</a></li>
</ul>
</li>
<li><a href="../community/">Community</a></li>
<li><a href="../license/">License</a></li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li><a href="http://blog.fontawesome.io">Blog</a></li>
</ul>
</div>
</div>
</div>
<div class="jumbotron jumbotron-ad hidden-print">
<div class="container">
<h1><i class="fa fa-cogs"></i>&nbsp; Get Started</h1>
<p>Easy ways to get Font Awesome 4.0.0 onto your website</p>
</div>
</div>
<div id="social-buttons" class="hidden-print">
<div class="container">
<ul class="list-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="hidden-print">
<div class="stripe-ad">
<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>
<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 3</a>!
</p>
</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 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.
<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/font-awesome/4.0.0/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>
</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="../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.
<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>
</code></pre></div>
</li>
<li>Check out the <a href="../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:
<div class="highlight"><pre><code class="bash">gem <span class="s1">&#39;font-awesome-sass&#39;</span>
</code></pre></div>
</li>
<li>
And then execute:
<div class="highlight"><pre><code class="bash"><span class="nv">$ </span>bundle
</code></pre></div>
</li>
<li>Or install it yourself as:
<div class="highlight"><pre><code class="bash"><span class="nv">$ </span>gem install font-awesome-sass
</code></pre></div>
</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 3.0.0 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.
<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>
</code></pre></div>
<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="../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 4.0.0
doesn't support IE7, but an older version does. You'll need to check out the
<a href="../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>
<section id="troubleshooting">
<h2 class="page-header">Troubleshooting</h2>
<p>
If you're having trouble with Font Awesome, make sure to check out the
<a href="https://github.com/FortAwesome/Font-Awesome/wiki/Troubleshooting">troubleshooting wiki page</a>.
Generously maintained by <a href="https://twitter.com/gtagliala">@gtagliala</a>.
</p>
</section>
</div>
</div>
<footer id="footer" class="footer hidden-print">
<div class="container text-center">
<div>
<i class="fa fa-flag"></i> Font Awesome 4.0.0
<span class="hide-xs">&middot;</span><br class="hide-sm hide-md hide-lg">
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="hide-xs">&middot;</span><br class="hide-sm hide-md hide-lg">
Code licensed under <a href="http://opensource.org/licenses/mit-license.html">MIT License</a>
<span class="hide-xs hide-sm">&middot;</span><br class="hide-md hide-lg">
Documentation licensed under <a href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>
</div>
<div>
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>
</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.10.2.min.js"></script>
<script src="../assets/js/ZeroClipboard-1.1.7.min.js"></script>
<script src="../assets/js/bootstrap-3.0.0.min.js"></script>
<script src="../assets/js/site.js"></script>
</body>
</html>