--- layout: base title: Get Started with Fork Awesome navbar_active: get-started view_class: v-get-started relative_path: ../ --- {% capture jumbotron_h1 %}  Get Started{% endcapture %} {% capture jumbotron_p %}Easy ways to get {{ site.forkawesome.name }} {{ site.forkawesome.version }} onto your website{% endcapture %} {% include jumbotron.html %}

Use a CDN

The simplest way to get {{ site.forkawesome.name }} in your project is to copy the line below in between the <head> tags of your HTML source files. Then check the examples to start displaying icons.

{% highlight html %} {% endhighlight %}

Thanks to jsDelivr for providing the CDN for {{ site.forkawesome.name }}

or

Download & Customize

Want to manage and host {{ site.forkawesome.name }} assets yourself? You can download, customize, and use the icons and default styling manually. Both CSS and CSS Preprocessor (Sass and Less) formats are included.

Download

Using CSS

  1. Copy the entire fork-awesome directory into your project.
  2. In the <head> of your html, reference the location to your font-awesome.min.css. {% highlight html %} {% endhighlight %}
  3. Check out the examples to start using {{ site.forkawesome.name }}!

Using Sass or Less

Use this method to customize {{ site.forkawesome.name }} {{ site.forkawesome.version }} using Less or Sass.

  1. Copy the fork-awesome/ directory into your project.
  2. Open your project's fork-awesome/less/variables.less or fork-awesome/scss/_variables.scss and edit the @fa-font-path or $fa-font-path variable to point to your font directory. {% highlight scss %} @fa-font-path: "../font"; {% endhighlight %}

    The font path is relative from your compiled CSS directory.

  3. Re-compile your Less or Sass if using a static compiler. Otherwise, you should be good to go.
  4. Check out the examples to start using {{ site.forkawesome.name }}!
or

Use {{ site.forkawesome.name }} in your C or C++ applications

Juliette Foucault has created a little library called IconFontCppHeaders to help use a few icon fonts in your C or C++ projects and {{ site.forkawesome.name }} is part of it.

{% highlight c %} #include "IconsForkAwesome.h" {% endhighlight %}

More Information

Validators

In order to provide the best possible experience to old and buggy browsers, {{ site.forkawesome.name }} uses CSS browser hacks 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.

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.

Getting started - Validators by Bootstrap Team is licensed under CC BY 3.0

Internet Explorer 8 and @font-face

IE8 has some issues with @font-face when combined with :before. {{ site.forkawesome.name }} 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. See issue #954 for details.

Getting started - Internet Explorer 8 and @font-face by Bootstrap Team is licensed under CC BY 3.0

Need IE7 Support?

Sorry, {{ site.forkawesome.name }} {{ site.forkawesome.version }} doesn't support IE7, but an older version of {{ site.fontawesome.name }} does (v3.2.1, if you can still find it).

{% include modals/download.html %}