diff options
Diffstat (limited to 'live/static/fork-awesome/src/doc/get-started.html')
| -rw-r--r-- | live/static/fork-awesome/src/doc/get-started.html | 143 |
1 files changed, 143 insertions, 0 deletions
diff --git a/live/static/fork-awesome/src/doc/get-started.html b/live/static/fork-awesome/src/doc/get-started.html new file mode 100644 index 0000000..59dc25c --- /dev/null +++ b/live/static/fork-awesome/src/doc/get-started.html @@ -0,0 +1,143 @@ +--- +layout: base +title: Get Started with Fork Awesome +navbar_active: get-started +view_class: v-get-started +relative_path: ../ +--- +{% capture jumbotron_h1 %}<i class="fa fa-cogs" aria-hidden="true"></i> Get Started{% endcapture %} +{% capture jumbotron_p %}Easy ways to get {{ site.forkawesome.name }} {{ site.forkawesome.version }} onto your website{% endcapture %} + +{% include jumbotron.html %} + +<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 {{ site.forkawesome.name }} 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="{{ page.relative_path }}examples/">examples</a> to start displaying icons. + <p> +{% highlight html %} +<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/fork-awesome@{{ site.forkawesome.version }}/css/fork-awesome.min.css" integrity="{% sri_hash css/fork-awesome.min.css %}" crossorigin="anonymous"> +{% endhighlight %} + </p> + <p>Thanks to <a href="https://www.jsdelivr.com/package/npm/fork-awesome">jsDelivr</a> for providing the CDN for {{ site.forkawesome.name }}</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 {{ site.forkawesome.name }} 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. +{% highlight html %} +<link rel="stylesheet" href="path/to/fork-awesome/css/fork-awesome.min.css"> +{% endhighlight %} + </li> + <li>Check out the <a href="{{ page.relative_path }}examples/">examples</a> to start using {{ site.forkawesome.name }}!</li> + </ol> + </div> + + <div class="download-preprocessors" id="download-preprocessors"> + <h3>Using Sass or Less</h3> + + <p>Use this method to customize {{ site.forkawesome.name }} {{ site.forkawesome.version }} 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. +{% highlight scss %} +@fa-font-path: "../font"; +{% endhighlight %} + <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="{{ page.relative_path }}examples/">examples</a> to start using {{ site.forkawesome.name }}!</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 {{ site.forkawesome.name }} 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 {{ site.forkawesome.name }} is part of it.</p> +{% highlight c %} +#include "IconsForkAwesome.h" +{% endhighlight %} + </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, {{ site.forkawesome.name }} 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>. + {{ 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. + <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, {{ 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). + </p> + </div> + </div> + +{% include modals/download.html %} |