mirror of
https://github.com/FortAwesome/Font-Awesome.git
synced 2024-12-30 23:41:28 +08:00
324 lines
15 KiB
HTML
324 lines
15 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 and CSS framework">
|
|
<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>
|
|
<script type="text/javascript">
|
|
(function(){
|
|
var bsa = document.createElement('script');
|
|
bsa.type = 'text/javascript';
|
|
bsa.async = true;
|
|
bsa.src = 'http://s3.buysellads.com/ac/bsa.js';
|
|
(document.getElementsByTagName('head')[0]||document.getElementsByTagName('body')[0]).appendChild(bsa);
|
|
})();
|
|
</script>
|
|
<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-bars 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> Icons</a></li>
|
|
<li class="divider"></li>
|
|
<li><a href="../icons/#new"><i class="fa fa-cube fa-fw"></i> New Icons in 4.1</a></li>
|
|
<li><a href="../icons/#web-application"><i class="fa fa-camera-retro fa-fw"></i> Web Application Icons</a></li>
|
|
<li><a href="../icons/#file-type"><i class="fa fa-file-image-o fa-fw"></i> File Type Icons</a></li>
|
|
<li><a href="../icons/#spinner"><i class="fa fa-spinner fa-fw"></i> Spinner Icons</a></li>
|
|
<li><a href="../icons/#form-control"><i class="fa fa-check-square fa-fw"></i> Form Control Icons</a></li>
|
|
<li><a href="../icons/#currency"><i class="fa fa-won fa-fw"></i> Currency Icons</a></li>
|
|
<li><a href="../icons/#text-editor"><i class="fa fa-file-text-o fa-fw"></i> Text Editor Icons</a></li>
|
|
<li><a href="../icons/#directional"><i class="fa fa-hand-o-right fa-fw"></i> Directional Icons</a></li>
|
|
<li><a href="../icons/#video-player"><i class="fa fa-play-circle fa-fw"></i> Video Player Icons</a></li>
|
|
<li><a href="../icons/#brand"><i class="fa fa-github fa-fw"></i> Brand Icons</a></li>
|
|
<li><a href="../icons/#medical"><i class="fa fa-medkit fa-fw"></i> 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/#basic">Basic 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 & 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> Get Started</h1>
|
|
<p>Easy ways to get Font Awesome 4.1.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 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>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="container">
|
|
|
|
<section class="hidden-print">
|
|
<div class="stripe-ad">
|
|
<script type="text/javascript" src="//cdn.fusionads.net/fusion.js?zoneid=1332&serve=C6SDP2Y&placement=fontawesome" id="_fusionads_js"></script>
|
|
|
|
|
|
<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/#fontawesome_tab">BootstrapCDN</a> by <a href="http://maxcdn.com">MaxCDN</a></h2>
|
|
<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>
|
|
<ol>
|
|
<li>
|
|
Paste the following code into the <code><head></code> section of your site's HTML.
|
|
<div class="highlight"><pre><code class="html"><span class="nt"><link</span> <span class="na">href=</span><span class="s">"//maxcdn.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.min.css"</span> <span class="na">rel=</span><span class="s">"stylesheet"</span><span class="nt">></span>
|
|
</code></pre></div>
|
|
<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>
|
|
</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><head></code> of your html, reference the location to your font-awesome.min.css.
|
|
<div class="highlight"><pre><code class="html"><span class="nt"><link</span> <span class="na">rel=</span><span class="s">"stylesheet"</span> <span class="na">href=</span><span class="s">"path/to/font-awesome/css/font-awesome.min.css"</span><span class="nt">></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-less">
|
|
<h2 class="page-header">EASY: <a href="https://github.com/FortAwesome/font-awesome-less">LESS Ruby Gem</a></h2>
|
|
<p>
|
|
Use the <a href="https://github.com/FortAwesome/font-awesome-less">Official Font Awesome LESS Ruby Gem</a> to easily get Font
|
|
Awesome LESS 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">'font-awesome-less'</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-less
|
|
</code></pre></div>
|
|
</li>
|
|
</ol>
|
|
</section>
|
|
|
|
<section id="ruby-gem-sass">
|
|
<h2 class="page-header">EASY: <a href="https://github.com/FortAwesome/font-awesome-sass">SASS Ruby Gem</a></h2>
|
|
<p>
|
|
Use the <a href="https://github.com/FortAwesome/font-awesome-sass">Official Font Awesome SASS Ruby Gem</a> to easily get Font
|
|
Awesome SASS 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">'font-awesome-sass'</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 SASS</h2>
|
|
<p>Use this method to customize Font Awesome 4.1.0 using LESS or SASS.</p>
|
|
<ol>
|
|
<li>Copy the <code>font-awesome/</code> directory into your project.</li>
|
|
<li>
|
|
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>
|
|
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">"../font"</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 SASS 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.1.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 id="bsap_1298241" class="bsarocks bsap_b1146e3f9fa32a794fc6d2c7be47ece8"></div>
|
|
<div>
|
|
<i class="fa fa-flag"></i> Font Awesome 4.1.0
|
|
<span class="hide-xs">·</span><br class="hide-sm hide-md hide-lg">
|
|
Created 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">·</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">·</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> ·
|
|
<a href="https://github.com/FortAwesome/Font-Awesome/issues">Issues</a> ·
|
|
<a href="../3.2.1">Old 3.2.1 Docs</a>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
|
|
<script src="http://platform.twitter.com/widgets.js"></script>
|
|
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
|
|
<script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
|
|
<script src="../assets/js/site.js"></script>
|
|
|
|
</body>
|
|
</html>
|