mirror of
https://github.com/ForkAwesome/Fork-Awesome
synced 2024-05-23 16:52:16 +02:00
322 lines
18 KiB
HTML
322 lines
18 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">
|
|
<meta name="description" content="Fork Awesome, a fork of the iconic font and CSS framework">
|
|
<meta name="author" content="The Fork Awesome community">
|
|
<link rel="shortcut icon" href="../assets/ico/favicon.ico">
|
|
|
|
<title>Get Started with Fork Awesome</title>
|
|
|
|
<!-- CSS
|
|
================================================== -->
|
|
<link rel="stylesheet" href="../assets/css/site.css">
|
|
<link rel="stylesheet" href="../assets/css/pygments.css">
|
|
<link rel="stylesheet" href="../assets/css/share.min.css">
|
|
<link rel="stylesheet" href="../assets/fork-awesome/css/fork-awesome.css">
|
|
|
|
<!-- Twitter
|
|
================================================== -->
|
|
<meta name="twitter:title" content="Get Started with Fork Awesome">
|
|
<meta name="twitter:card" content="summary_large_image">
|
|
<meta name="twitter:description" content="Fork Awesome, a fork of the iconic font and CSS toolkit">
|
|
<meta name="twitter:image" content="https://forkawesome.github.io/Fork-Awesome/assets/images/banner.jpg">
|
|
|
|
<!-- FACEBOOK
|
|
================================================== -->
|
|
<meta property="og:url" content="https://forkawesome.github.io/Fork-Awesome/">
|
|
<meta property="og:title" content="Get Started with Fork Awesome">
|
|
<meta name="description" property="og:description" content="Fork Awesome, a fork of the iconic font and CSS toolkit" />
|
|
<meta property="og:image" content="https://forkawesome.github.io/Fork-Awesome/assets/images/banner.jpg">
|
|
|
|
<!--[if lt IE 9]>
|
|
<script src="../assets/js/html5shiv.js"></script>
|
|
<script src="../assets/js/respond.min.js"></script>
|
|
<![endif]-->
|
|
|
|
</head>
|
|
<body class="font-awesome v-get-started">
|
|
<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">
|
|
<i class="fa fa-bars fa-lg" aria-hidden="true" title="Toggle navigation"></i>
|
|
<span class="sr-only">Toggle navigation</span>
|
|
</button>
|
|
<a class="navbar-brand" href="../"><i class="fa fa-fork-awesome" aria-hidden="true"></i> Fork 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="hidden-sm active"><a href="../get-started/">Get Started</a></li>
|
|
<li class="hidden-xs hidden-md hidden-lg active">
|
|
<a href="../get-started/">Start</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" aria-hidden="true" title="Toggle dropdown menu"></i>
|
|
<span class="sr-only">Toggle dropdown menu</span>
|
|
<span class="toggle drop down"></span>
|
|
</a>
|
|
<ul class="dropdown-menu pull-right">
|
|
<li><a href="../icons/"><i class="fa fa-flag fa-fw" aria-hidden="true"></i> All Icons</a></li>
|
|
<li class="divider"></li>
|
|
<li><a href="../icons/#new"><i class="fa fa-handshake-o fa-fw" aria-hidden="true"></i> New Icons</a></li>
|
|
<li><a href="../icons/#web-application"><i class="fa fa-camera-retro fa-fw" aria-hidden="true"></i> Web Application Icons</a></li>
|
|
<li><a href="../icons/#accessibility"><i class="fa fa-universal-access fa-fw" aria-hidden="true"></i> Accessibility Icons</a></li>
|
|
<li><a href="../icons/#hand"><i class="fa fa-hand-spock-o fa-fw" aria-hidden="true"></i> Hand Icons</a></li>
|
|
<li><a href="../icons/#transportation"><i class="fa fa-ship fa-fw" aria-hidden="true"></i> Transportation Icons</a></li>
|
|
<li><a href="../icons/#gender"><i class="fa fa-venus fa-fw" aria-hidden="true"></i> Gender Icons</a></li>
|
|
<li><a href="../icons/#file-type"><i class="fa fa-file-image-o fa-fw" aria-hidden="true"></i> File Type Icons</a></li>
|
|
<li><a href="../icons/#spinner"><i class="fa fa-spinner fa-fw" aria-hidden="true"></i> Spinner Icons</a></li>
|
|
<li><a href="../icons/#form-control"><i class="fa fa-check-square fa-fw" aria-hidden="true"></i> Form Control Icons</a></li>
|
|
<li><a href="../icons/#payment"><i class="fa fa-credit-card fa-fw" aria-hidden="true"></i> Payment Icons</a></li>
|
|
<li><a href="../icons/#chart"><i class="fa fa-pie-chart fa-fw" aria-hidden="true"></i> Chart Icons</a></li>
|
|
<li><a href="../icons/#currency"><i class="fa fa-won fa-fw" aria-hidden="true"></i> Currency Icons</a></li>
|
|
<li><a href="../icons/#text-editor"><i class="fa fa-file-text-o fa-fw" aria-hidden="true"></i> Text Editor Icons</a></li>
|
|
<li><a href="../icons/#directional"><i class="fa fa-arrow-right fa-fw" aria-hidden="true"></i> Directional Icons</a></li>
|
|
<li><a href="../icons/#video-player"><i class="fa fa-play-circle fa-fw" aria-hidden="true"></i> Video Player Icons</a></li>
|
|
<li><a href="../icons/#brand"><i class="fa fa-facebook-official fa-fw" aria-hidden="true"></i> Brand Icons</a></li>
|
|
<li><a href="../icons/#medical"><i class="fa fa-medkit fa-fw" aria-hidden="true"></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" aria-hidden="true" title="Toggle dropdown menu"></i>
|
|
<span class="sr-only">Toggle dropdown menu</span>
|
|
<span class="toggle drop down"></span>
|
|
</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/#animated">Animated Icons</a></li>
|
|
<li><a href="../examples/#accessible">Accessibility-Minded</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 class="hidden-sm"><a href="../accessibility/">Accessibility</a></li>
|
|
<li class="hidden-xs hidden-md hidden-lg"><a href="../accessibility/"><i class="fa fa-universal-access"></i></a></li>
|
|
<li><a href="../community/">Community</a></li>
|
|
<li><a href="../license/">License</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="jumbotron jumbotron-ad hidden-print">
|
|
<div class="container">
|
|
|
|
<h1><i class="fa fa-cogs" aria-hidden="true"></i> Get Started</h1>
|
|
<p>Easy ways to get Fork Awesome 1.2.0 onto your website</p>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="container">
|
|
<section class="get-started-CDN margin-top-lg" id="get-started-CDN">
|
|
<h2 class="page-header clearfix">
|
|
Use a CDN
|
|
</h2>
|
|
|
|
<div class="row">
|
|
<div class="col-md-12">
|
|
<p>The simplest way to get Fork Awesome in your project is to copy the line below in between the <code><head></code> tags of your HTML source files. Then check the <a href="../examples/">examples</a> to start displaying icons.
|
|
<p>
|
|
<figure class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><link</span> <span class="na">rel=</span><span class="s">"stylesheet"</span> <span class="na">href=</span><span class="s">"https://cdn.jsdelivr.net/npm/fork-awesome@1.2.0/css/fork-awesome.min.css"</span> <span class="na">integrity=</span><span class="s">"sha256-XoaMnoYC5TH6/+ihMEnospgm0J1PM/nioxbOUdnM8HY="</span> <span class="na">crossorigin=</span><span class="s">"anonymous"</span><span class="nt">></span></code></pre></figure>
|
|
</p>
|
|
<p>Thanks to <a href="https://www.jsdelivr.com/package/npm/fork-awesome">jsDelivr</a> for providing the CDN for Fork Awesome</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
<div class="hr margin-top-xl">
|
|
<span class="hr-text text-xl text-muted">or</span>
|
|
</div>
|
|
|
|
<section class="get-started-download" id="get-started-download">
|
|
<h2 class="page-header clearfix">
|
|
Download & Customize
|
|
</h2>
|
|
|
|
<div class="row">
|
|
<div class="col-md-9">
|
|
<p class="text-lg">
|
|
Want to manage and host Fork Awesome assets yourself? You can
|
|
<a href="#modal-download" data-toggle="modal">download</a>,
|
|
customize, and use the icons and default styling manually. Both CSS and CSS Preprocessor (Sass and Less) formats are included.</p>
|
|
</div>
|
|
|
|
<div class="col-md-3">
|
|
<a class="btn btn-default btn-lg btn-block" href="#modal-download" data-toggle="modal">
|
|
<i class="fa fa-download fa-lg margin-right-sm"></i>
|
|
Download
|
|
</a>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="download-css margin-bottom-xl" id="download-css">
|
|
<h3>Using CSS</h3>
|
|
|
|
<ol>
|
|
<li>Copy the entire <code>fork-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.
|
|
<figure class="highlight"><pre><code class="language-html" data-lang="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/fork-awesome/css/fork-awesome.min.css"</span><span class="nt">></span></code></pre></figure>
|
|
</li>
|
|
<li>Check out the <a href="../examples/">examples</a> to start using Fork Awesome!</li>
|
|
</ol>
|
|
</div>
|
|
|
|
<div class="download-preprocessors" id="download-preprocessors">
|
|
<h3>Using Sass or Less</h3>
|
|
|
|
<p>Use this method to customize Fork Awesome 1.2.0 using Less or Sass.</p>
|
|
<ol>
|
|
<li>Copy the <code>fork-awesome/</code> directory into your project.</li>
|
|
<li>
|
|
Open your project's <code>fork-awesome/less/variables.less</code> or <code>fork-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.
|
|
<figure class="highlight"><pre><code class="language-scss" data-lang="scss"><span class="k">@fa-font-path</span><span class="nd">:</span> <span class="s2">"../font"</span><span class="p">;</span></code></pre></figure>
|
|
<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 Fork Awesome!</li>
|
|
</ol>
|
|
</div>
|
|
</section>
|
|
|
|
<div class="hr margin-top-xl">
|
|
<span class="hr-text text-xl text-muted">or</span>
|
|
</div>
|
|
|
|
<section class="get-started-Cpp margin-top-lg" id="get-started-Cpp">
|
|
<h2 class="page-header clearfix">
|
|
Use Fork Awesome in your C or C++ applications
|
|
</h2>
|
|
|
|
<div class="row">
|
|
<div class="col-md-12">
|
|
<p>Juliette Foucault has created a little library called <a href="https://github.com/juliettef/IconFontCppHeaders">IconFontCppHeaders</a> to help use a few icon fonts in your C or C++ projects and Fork Awesome is part of it.</p>
|
|
<figure class="highlight"><pre><code class="language-c" data-lang="c"><span class="cp">#include "IconsForkAwesome.h"</span></code></pre></figure>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
<div class="hr margin-top-xl">
|
|
</div>
|
|
|
|
<section class="get-started-more margin-top-lg" id="get-started-more">
|
|
<h2 class="page-header">More Information</h2>
|
|
</section>
|
|
|
|
<div class="row">
|
|
<div class="col-md-6" id="support-validators">
|
|
<h4>Validators</h4>
|
|
<p>In order to provide the best possible experience to old and buggy browsers, Fork Awesome uses <a href="http://browserhacks.com">CSS browser hacks</a> in several places to target special CSS to certain browser versions in order to work around bugs in the browsers themselves. These hacks understandably cause CSS validators to complain that they are invalid. In a couple places, we also use bleeding-edge CSS features that aren't yet fully standardized, but these are used purely for progressive enhancement.</p>
|
|
<p>These validation warnings don't matter in practice since the non-hacky portion of our CSS does fully validate and the hacky portions don't interfere with the proper functioning of the non-hacky portion, hence why we deliberately ignore these particular warnings.</p>
|
|
<p><a href="http://getbootstrap.com/getting-started/#support-validators">Getting started - Validators</a> by <a href="http://getbootstrap.com/about/#team">Bootstrap Team</a> is licensed under <a href="https://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a></p>
|
|
</div>
|
|
|
|
<div class="col-md-6" id="ie8-font-face">
|
|
<h4>Internet Explorer 8 and @font-face</h4>
|
|
<p>IE8 has some issues with <code>@font-face</code> when combined with <code>:before</code>.
|
|
Fork Awesome uses that combination. If a page is cached, and loaded without the mouse over the window
|
|
(i.e. hit the refresh button or load something in an iframe) then the page gets rendered before the font loads.
|
|
Hovering over the page (body) will show some of the icons and hovering over the remaining icons will show those as well.
|
|
<a href="https://github.com/FortAwesome/Font-Awesome/issues/954">See issue #954</a> for details.</p>
|
|
<p><a href="http://getbootstrap.com/getting-started/#support-ie8-font-face">Getting started - Internet Explorer 8 and @font-face</a> by <a href="http://getbootstrap.com/about/#team">Bootstrap Team</a> is licensed under <a href="https://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a></p>
|
|
|
|
<h4>Need IE7 Support?</h4>
|
|
<p>
|
|
Sorry, Fork Awesome 1.2.0
|
|
doesn't support IE7, but an older version of Font Awesome does (v3.2.1, if you can still find it).
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="modal fade" id="modal-download" tabindex="-1" role="dialog" aria-labelledby="modal-download-label"
|
|
xmlns="http://www.w3.org/1999/html">
|
|
<div class="modal-dialog" role="document">
|
|
<div class="modal-content">
|
|
<div class="modal-header">
|
|
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><i class="fa fa-times" aria-hidden="true"></i><span class="close"></span></button>
|
|
<h2 class="modal-title" id="modal-download-label">
|
|
<i class="fa fa-download fa-lg" aria-hidden="true"></i>
|
|
Download
|
|
</h2>
|
|
</div>
|
|
<div class="modal-body">
|
|
<a class="btn btn-primary btn-lg btn-block" href="https://github.com/ForkAwesome/Fork-Awesome/archive/1.2.0.zip">
|
|
Fork Awesome 1.2.0
|
|
</a>
|
|
<div class="row margin-bottom-lg margin-top-lg">
|
|
<div class="col-md-12 text-center">
|
|
More ways to install Fork Awesome coming soon!<br/>
|
|
In the meantime, don't forget to read <a href="../get-started">how to get started</a>.
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
<footer id="footer" class="footer hidden-print">
|
|
<div class="container text-center">
|
|
<div>
|
|
<i class="fa fa-fork" aria-hidden="true"></i> Fork Awesome 1.2.0
|
|
<span class="hide-xs">·</span><br class="hide-sm hide-md hide-lg">
|
|
A fork of Font Awesome, originally created by <a href="https://twitter.com/davegandy">Dave Gandy</a>, now maintained by a community.
|
|
</div>
|
|
<div>
|
|
Fork Awesome is 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 is 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 is licensed under <a href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>
|
|
</div>
|
|
<div class="project">
|
|
<a href="https://github.com/ForkAwesome/Fork-Awesome">GitHub Project</a> ·
|
|
<a href="https://github.com/ForkAwesome/Fork-Awesome/issues">Issues</a>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
|
|
<script src="https://ajax.aspnetcdn.com/ajax/jquery.validate/1.13.1/jquery.validate.min.js"></script>
|
|
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/js/bootstrap.min.js"></script>
|
|
<script src="../assets/js/site.js"></script>
|
|
<script src="../assets/js/share.min.js"></script>
|
|
|
|
</body>
|
|
</html>
|