documentation.html 14KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321
  1. <!doctype html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="UTF-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6. <title>Documentation Icon Font - Stroke Icons 7 - by Pixeden.</title>
  7. <!-- Docs CSS -->
  8. <link href="assets/libs/css/bootstrap.min.css" rel="stylesheet" />
  9. <link href="assets/libs/css/bootstrap-select.css" rel="stylesheet" />
  10. <link href="assets/libs/css/prism.css" rel="stylesheet" />
  11. <link href="assets/docs/style.css" rel="stylesheet" />
  12. <!-- Icon font CSS -->
  13. <link href="pe-icon-7-stroke/css/pe-icon-7-stroke.css" rel="stylesheet" />
  14. <link href="pe-icon-7-stroke/css/helper.css" rel="stylesheet" />
  15. </head>
  16. <body>
  17. <header id="top-bar">
  18. <div class="container">
  19. <img src="assets/images/logo.png" alt="logo"/>
  20. </div>
  21. </header> <!-- /top-bar -->
  22. <section id="hero_box">
  23. <div class="container">
  24. <h1>Documentation</h1>
  25. <p>You will find in this document details on how to use our icon font and a list of useful helper classes.</p>
  26. </div>
  27. </section> <!-- /hero_box -->
  28. <section id="docs_box">
  29. <div class="container">
  30. <section id="default-css">
  31. <h2 class="page-header">Add our icon font <small>to your website</small></h2>
  32. <ol>
  33. <li>Copy the entire <code>pe-icon-7-stroke</code> directory into your project.</li>
  34. <li>
  35. In the <code>&lt;head&gt;</code> of your html, reference the location to our icon font CSS: <span class="italic">pe-icon-7-stroke.css</span> and if needed helper CSS: <span class="italic">helper.css</span>.
  36. <pre class="language-markup"><code>&lt;link rel=&quot;stylesheet&quot; href=&quot;path/to/pe-icon-7-stroke/css/pe-icon-7-stroke.css&quot;&gt;
  37. &lt;!-- Optional - Adds useful class to manipulate icon font display --&gt;
  38. &lt;link rel=&quot;stylesheet&quot; href=&quot;path/to/pe-icon-7-stroke/css/helper.css&quot;&gt;</code></pre>
  39. </li>
  40. </ol>
  41. </section>
  42. <section id="inline">
  43. <h2 class="page-header">Place the icons <small>in your HTML</small></h2>
  44. <div class="row">
  45. <div class="col-md-3 col-sm-4">
  46. <p>
  47. <span class="pe-7s-map-marker"></span> pe-7s-map-marker <br/>
  48. <i class="pe-7s-home"></i> pe-7s-home
  49. </p>
  50. </div>
  51. <div class="col-md-9 col-sm-8">
  52. <p>Easiest way is to place your icon inline using a html tag such as <code>&lt;span&gt;</code> or <code>&lt;i&gt;</code></p>
  53. <pre class="language-markup">
  54. <code>&lt;span class=&quot;pe-7s-map-marker&quot;&gt;&lt;/span&gt; pe-7s-map-marker
  55. &lt;i class=&quot;pe-7s-home&quot;&gt;&lt;/i&gt; pe-7s-home</code></pre>
  56. <div class="alert alert-success"><i class="pe-lg pe-7s-info"></i> icon unicode is added with CSS and the pseudo-class :before.</div>
  57. </div>
  58. </div>
  59. </section>
  60. <section id="icomoon">
  61. <h2 class="page-header">Compatible with Icomoon <small>font creator tool</small></h2>
  62. <p>The IcoMoon app lets you build and use your own icon sets: <a target="_blank" href="http://icomoon.io/app/">IcoMoon App</a>.<br>
  63. You can import <code>icomoon/*selection.json*</code> in the IcoMoon app using the *Import Icons* button (or via Main Menu > Manage Projects) to retrieve this specific icon font.<br>
  64. This way you can mix and match our icon font with other fonts or select only the icons you need and generate a new font.
  65. </p>
  66. </section>
  67. <section id="helper">
  68. <h2 class="page-header">Helper classes <small>based on font-awesome useful classes <span class="italic">(optional)</span></small></h2>
  69. <p> Below you will find a list of useful classes to modify the icon display, layout, sizes etc... They come with the helper.css file and are based on a modified version of font-awesome classes.
  70. <strong>Important:</strong> <span class="italic"> if you already use font-awesome (FA) icon font in your website, you might want to delete the classes in the helper file under <code>/* FA based classes */</code> and use the FA classes instead.</span></p>
  71. </section>
  72. <section id="larger">
  73. <h3 class="page-header">Larger Icons &amp; Vertical Align </h2>
  74. <div class="row">
  75. <div class="col-md-3 col-sm-4">
  76. <p><i class="pe-7s-map-marker pe-lg pe-va"></i> pe-7s-map-marker</p>
  77. <p><i class="pe-7s-map-marker pe-2x pe-va"></i> pe-7s-map-marker</p>
  78. <p><i class="pe-7s-map-marker pe-3x pe-va"></i> pe-7s-map-marker</p>
  79. <p><i class="pe-7s-map-marker pe-4x pe-va"></i> pe-7s-map-marker</p>
  80. <p><i class="pe-7s-map-marker pe-5x pe-va"></i> pe-7s-map-marker</p>
  81. </div>
  82. <div class="col-md-9 col-sm-8">
  83. <p>
  84. To increase icon sizes relative to their container, use the <code>pe-lg</code> (33% increase), <code>pe-2x</code>,
  85. <code>pe-3x</code>, <code>pe-4x</code>, or <code>pe-5x</code> classes.<br/>
  86. To align the icon at the middle of a text, use the <code>pe-va</code> class.
  87. </p>
  88. <pre class="language-markup"><code>&lt;p&gt;&lt;i class=&quot;pe-7s-map-marker pe-lg pe-va&quot;&gt;&lt;/i&gt; pe-7s-map-marker&lt;/p&gt;
  89. &lt;p&gt;&lt;i class=&quot;pe-7s-map-marker pe-2x pe-va&quot;&gt;&lt;/i&gt; pe-7s-map-marker&lt;/p&gt;
  90. &lt;p&gt;&lt;i class=&quot;pe-7s-map-marker pe-3x pe-va&quot;&gt;&lt;/i&gt; pe-7s-map-marker&lt;/p&gt;
  91. &lt;p&gt;&lt;i class=&quot;pe-7s-map-marker pe-4x pe-va&quot;&gt;&lt;/i&gt; pe-7s-map-marker&lt;/p&gt;
  92. &lt;p&gt;&lt;i class=&quot;pe-7s-map-marker pe-5x pe-va&quot;&gt;&lt;/i&gt; pe-7s-map-marker&lt;/p&gt;
  93. </code></pre>
  94. <div class="alert alert-success">
  95. <i class="pe-7s-attention pe-lg"></i> If your icons are getting chopped off on top and bottom, make sure you have
  96. sufficient line-height. pe-7s-attention
  97. </div>
  98. </div>
  99. </div>
  100. </section>
  101. <section id="fixed-width">
  102. <h2 class="page-header">Fixed Width Icons</h2>
  103. <div class="row">
  104. <div class="col-md-3 col-sm-4">
  105. <ul class="nav nav-pills nav-stacked margin-bottom">
  106. <li class="active"><a href="#"><i class="pe-7s-home pe-fw"></i>&nbsp; Home</a></li>
  107. <li><a href="#"><i class="pe-7s-culture pe-fw"></i>&nbsp; Library</a></li>
  108. <li><a href="#"><i class="pe-7s-browser pe-fw"></i>&nbsp; Applications</a></li>
  109. <li><a href="#"><i class="pe-7s-config pe-fw"></i>&nbsp; Settings</a></li>
  110. </ul>
  111. </div>
  112. <div class="col-md-9 col-sm-8">
  113. <p>
  114. Use <code>pe-fw</code> to set icons at a fixed width. Great to use when variable icon widths throw off alignment.
  115. Especially useful in things like nav lists. <span class="italic">(Reminder: nav list classes in the example are from bootstrap)</span>
  116. </p>
  117. <pre class="language-markup"><code>&lt;ul class="nav nav-pills nav-stacked"&gt;
  118. &lt;li class="active"&gt;&lt;a href="#"&gt;&lt;i class="pe-7s-home pe-fw"&gt;&lt;/i&gt; Home&lt;/a&gt;&lt;/li&gt;
  119. &lt;li class="active"&gt;&lt;a href="#"&gt;&lt;i class="pe-7s-culture pe-fw"&gt;&lt;/i&gt; Library&lt;/a&gt;&lt;/li&gt;
  120. &lt;li class="active"&gt;&lt;a href="#"&gt;&lt;i class="pe-7s-browser pe-fw"&gt;&lt;/i&gt; Applications&lt;/a&gt;&lt;/li&gt;
  121. &lt;li class="active"&gt;&lt;a href="#"&gt;&lt;i class="pe-7s-config pe-fw"&gt;&lt;/i&gt; Settings&lt;/a&gt;&lt;/li&gt;
  122. &lt;/ul&gt;</code></pre>
  123. </div>
  124. </div>
  125. </section>
  126. <section id="list">
  127. <h2 class="page-header">List Icons</h2>
  128. <div class="row">
  129. <div class="col-md-3 col-sm-4">
  130. <ul class="pe-ul">
  131. <li><i class="pe-li pe-7s-star"></i>List icons (like these)</li>
  132. <li><i class="pe-li pe-7s-angle-right"></i>can be used</li>
  133. <li><i class="pe-li pe-spin pe-7s-help2"></i>to easily replace</li>
  134. <li><i class="pe-li pe-7s-play"></i>default bullets in lists</li>
  135. </ul>
  136. </div>
  137. <div class="col-md-9 col-sm-8">
  138. <p>Use <code>pe-ul</code> and <code>pe-li</code> to easily replace default bullets in unordered lists.</p>
  139. <pre class="language-markup"><code>&lt;ul class="pe-ul"&gt;
  140. &lt;li&gt;&lt;i class="pe-li pe-7s-star"&gt;&lt;/i&gt; List icons (like these) &lt;/li&gt;
  141. &lt;li&gt;&lt;i class="pe-li pe-7s-angle-right"&gt;&lt;/i&gt; can be used &lt;/li&gt;
  142. &lt;li&gt;&lt;i class="pe-li pe-spin pe-7s-help2"&gt;&lt;/i&gt; to replace &lt;/li&gt;
  143. &lt;li&gt;&lt;i class="pe-li pe-7s-play"&gt;&lt;/i&gt; default bullets in lists &lt;/li&gt;
  144. &lt;/ul&gt;</code></pre>
  145. </div>
  146. </div>
  147. </section>
  148. <section id="bordered-pulled">
  149. <h2 class="page-header">Bordered &amp; Pulled Icons</h2>
  150. <div class="row">
  151. <div class="col-md-3 col-sm-4">
  152. <p>
  153. <i class="pe pe-7s-chat pe-2x pull-left pe-border"></i>
  154. Use a few styles together and you'll have easy pull quotes or a great introductory article icon.
  155. </p>
  156. </div>
  157. <div class="col-md-9 col-sm-8">
  158. <p>
  159. Use <code>pe-border</code> and <code>pull-right</code> or <code>pull-left</code> for easy pull quotes or
  160. article graphics.
  161. </p>
  162. <pre class="language-markup"><code>&lt;i class="pe pe-7s-chat pe-2x pull-left pe-border"&gt;&lt;/i&gt;
  163. Use a few styles together and you'll have easy pull quotes or a great introductory article icon.</code></pre>
  164. </div>
  165. </div>
  166. </section>
  167. <section id="spinning">
  168. <h2 class="page-header">Spinning Icons</h2>
  169. <div class="row">
  170. <div class="col-md-3 col-sm-4">
  171. <p>
  172. <i class="pe-7s-science pe-2x pe-spin"></i>
  173. <i class="pe-7s-refresh pe-2x pe-spin"></i>
  174. <i class="pe-7s-config pe-2x pe-spin"></i>
  175. </p>
  176. </div>
  177. <div class="col-md-9 col-sm-8">
  178. <p>
  179. Use the <code>pe-spin</code> class to get any icon to rotate. Works well with <code>pe-7s-science</code>,
  180. <code>pe-7s-refresh</code>, and <code>pe-7s-config</code>.
  181. </p>
  182. <pre class="language-markup"><code>&lt;i class="pe-7s-science pe-spin"&gt;&lt;/i&gt;
  183. &lt;i class="pe-7s-refresh pe-spin"&gt;&lt;/i&gt;
  184. &lt;i class="pe-7s-config pe-spin"&gt;&lt;/i&gt;</code></pre>
  185. <p class="alert alert-success">
  186. <i class="fa fa-info-circle"></i> CSS3 animations aren't supported in IE8 - IE9.
  187. </p>
  188. </div>
  189. </div>
  190. </section>
  191. <section id="rotated-flipped">
  192. <h2 class="page-header">Rotated &amp; Flipped</h2>
  193. <div class="row">
  194. <div class="col-md-3 col-sm-4">
  195. <p style="font-size: 18px;">
  196. <i class="pe-7s-graph3"></i>&nbsp; normal<br>
  197. <i class="pe-7s-graph3 pe-rotate-90"></i>&nbsp; fa-rotate-90<br>
  198. <i class="pe-7s-graph3 pe-rotate-180"></i>&nbsp; fa-rotate-180<br>
  199. <i class="pe-7s-graph3 pe-rotate-270"></i>&nbsp; fa-rotate-270<br>
  200. <i class="pe-7s-graph3 pe-flip-horizontal"></i>&nbsp; fa-flip-horizontal<br>
  201. <i class="pe-7s-graph3 pe-flip-vertical"></i>&nbsp; fa-flip-vertical
  202. </p>
  203. </div>
  204. <div class="col-md-9 col-sm-8">
  205. <p>
  206. To arbitrarily rotate and flip icons, use the <code>fa-rotate-*</code> and <code>fa-flip-*</code> classes.
  207. </p>
  208. <pre class="language-markup"><code>&lt;i class="pe-7s-graph3"&gt;&lt;/i&gt;&amp;nbsp; normal&lt;br&gt;
  209. &lt;i class="pe-7s-graph3 pe-rotate-90"&gt;&lt;/i&gt;&amp;nbsp; pe-rotate-90&lt;br&gt;
  210. &lt;i class="pe-7s-graph3 pe-rotate-180"&gt;&lt;/i&gt;&amp;nbsp; pe-rotate-180&lt;br&gt;
  211. &lt;i class="pe-7s-graph3 pe-rotate-270"&gt;&lt;/i&gt;&amp;nbsp; pe-rotate-270&lt;br&gt;
  212. &lt;i class="pe-7s-graph3 pe-flip-horizontal"&gt;&lt;/i&gt;&amp;nbsp; pe-flip-horizontal&lt;br&gt;
  213. &lt;i class="pe-7s-graph3 pe-flip-vertical"&gt;&lt;/i&gt;&amp;nbsp; pe-flip-vertical</code></pre>
  214. </div>
  215. </div>
  216. </section>
  217. <section id="stacked">
  218. <h2 class="page-header">Stacked Icons</h2>
  219. <div class="row">
  220. <div class="col-md-3 col-sm-4">
  221. <div class="margin-bottom">
  222. <span class="pe-stack pe-lg">
  223. <i class="pe-7s-monitor pe-stack-2x"></i>
  224. <i class="pe-7s-graph3 pe-stack-1x"></i>
  225. </span>
  226. <br>pe-7s-graph3 on pe-7s-monitor<br>
  227. <span class="pe-stack pe-lg">
  228. <i class="pe-7s-cloud pe-stack-2x blue"></i>
  229. <i class="pe-7s-gleam pe-stack-1x yellow"></i>
  230. </span>
  231. <br>pe-7s-gleam on pe-7s-cloud<br>
  232. <span class="pe-stack pe-lg">
  233. <i class="pe-7s-albums pe-stack-2x"></i>
  234. <i class="pe-7s-look pe-stack-1x"></i>
  235. </span>
  236. <br>pe-7s-look on pe-7s-albums<br>
  237. <span class="pe-stack pe-lg">
  238. <i class="pe-7s-umbrella pe-stack-2x red"></i>
  239. <i class="pe-7s-drop pe-stack-1x blue"></i>
  240. </span>
  241. <br>pe-7s-drop on pe-7s-umbrella
  242. </div>
  243. </div>
  244. <div class="col-md-9 col-sm-8">
  245. <p>
  246. To stack multiple icons, use the <code>pe-stack</code> class on the parent, the <code>pe-stack-1x</code>
  247. for the regularly sized icon, and <code>pe-stack-2x</code> for the larger icon. <code>pe-inverse</code>
  248. can be used as an alternative icon color and you can add your own color palette for more variations.
  249. </p>
  250. <pre class="language-markup"><code>&lt;span class="pe-stack pe-lg"&gt;
  251. &lt;i class="pe-7s-monitor pe-stack-2x"&gt;&lt;/i&gt;
  252. &lt;i class="pe-7s-graph3 pe-stack-1x"&gt;&lt;/i&gt;
  253. &lt;/span&gt;
  254. &lt;br&gt;pe-7s-graph3 on pe-7s-monitor&lt;br&gt;
  255. &lt;span class="pe-stack pe-lg"&gt;
  256. &lt;i class="pe-7s-cloud pe-stack-2x blue"&gt;&lt;/i&gt;
  257. &lt;i class="pe-7s-gleam pe-stack-1x yellow"&gt;&lt;/i&gt;
  258. &lt;/span&gt;
  259. &lt;br&gt;pe-7s-gleam on pe-7s-cloud&lt;br&gt;
  260. &lt;span class="pe-stack pe-lg"&gt;
  261. &lt;i class="pe-7s-albums pe-stack-2x"&gt;&lt;/i&gt;
  262. &lt;i class="pe-7s-look pe-stack-1x"&gt;&lt;/i&gt;
  263. &lt;/span&gt;
  264. &lt;br&gt;pe-7s-look on pe-7s-albums&lt;br&gt;
  265. &lt;span class="pe-stack pe-lg"&gt;
  266. &lt;i class="pe-7s-umbrella pe-stack-2x red"&gt;&lt;/i&gt;
  267. &lt;i class="pe-7s-drop pe-stack-1x blue"&gt;&lt;/i&gt;
  268. &lt;/span&gt;
  269. &lt;br&gt;pe-7s-drop on pe-7s-umbrella</code></pre>
  270. </div>
  271. </div>
  272. </section>
  273. </div> <!-- /container-->
  274. </section> <!-- /hero_box -->
  275. <footer class="main-footer">
  276. <div class="container">
  277. <p>
  278. 2014 © stroke Icon Font Set by Pixeden.
  279. <br/> Version · 1.2.0
  280. </p>
  281. </div>
  282. </footer>
  283. </div> <!-- /wrapper -->
  284. <!-- Scripts -->
  285. <script type="text/javascript" src="assets/libs/js/jquery-1.11.1.min.js"></script>
  286. <script type="text/javascript" src="assets/libs/js/bootstrap.min.js"></script>
  287. <script type="text/javascript" src="assets/libs/js/prism.js"></script>
  288. </body>
  289. </html>