forked from jmrashed/adibaicon
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.html
76 lines (71 loc) · 5.36 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css">
</head>
<body>
<div class="container">
<div class="row">
<h1 id="adibaicon-library">adibaIcon Library</h1>
<p>Welcome to adibaIcon Library! This library contains a collection of
customizable icons that you can easily integrate into your projects.</p>
<img src="./img/v1/Screenshot from 2023-08-30 01-44-35.png">
<img src="./img/v1/Screenshot from 2023-08-30 01-44-55.png">
<h2 id="cdn">CDN</h2>
<ul>
<li>Use as cdn : <a
href="https://adibaicon.vercel.app/css/adibaIcon.css">https://adibaicon.vercel.app/css/adibaIcon.css</a></li>
</ul>
<h2 id="getting-started">Getting Started</h2>
<p>To use the icons from this library, follow these steps:</p>
<ol type="1">
<li>Include the font files in your project directory.</li>
<li>Link the generated CSS file in your HTML or import it in your
project's stylesheets.</li>
</ol>
<h2 id="usage">Usage</h2>
<h3 id="basic-usage">Basic Usage</h3>
<p>To add an icon to your HTML, use the following structure:</p>
<div class="sourceCode" id="cb1"><pre
class="sourceCode html"><code class="sourceCode html"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="kw"><span</span> <span class="er">class</span><span class="ot">=</span><span class="st">"adiba-icon icon-r icon-lg icon-red"</span><span class="kw">></span></span></span></code></pre></div>
<p>img/Screenshot.png</p>
<h2 id="customization">Customization</h2>
<p>You can customize icons by using color and size classes:</p>
<ul>
<li><p><code>.icon-primary</code>: Sets the icon color to
primary.</p></li>
<li><p><code>.icon-secondary</code>: Sets the icon color to
secondary.</p></li>
<li><p><code>.icon-success</code>: Sets the icon color to
success.</p></li>
<li><p><code>.icon-lg</code>: Increases the icon size to large.</p></li>
<li><p><code>.icon-md</code>: Sets the icon size to medium.</p></li>
<li><p><code>.icon-sm</code>: Reduces the icon size to small.</p></li>
</ul>
<p>Combine color and size classes for complete customization:</p>
<div class="sourceCode" id="cb2"><pre
class="sourceCode html"><code class="sourceCode html"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="kw"><span</span> <span class="er">class</span><span class="ot">=</span><span class="st">"adiba-icon icon-r icon-lg icon-red"</span><span class="kw">></span></span></span></code></pre></div>
<h2 id="available-icons">Available Icons</h2>
<p>A: <span class="adiba-icon icon-a icon-lg icon-red"></span> B:
<span class="adiba-icon icon-b icon-md icon-blue"></span> C:
<span class="adiba-icon icon-c icon-sm icon-orange"></span></p>
<h2 id="demo">Demo</h2>
<div class="sourceCode" id="cb3"><pre
class="sourceCode html"><code class="sourceCode html"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="kw"><i</span> <span class="er">class</span><span class="ot">=</span><span class="st">"adiba-icon icon-r icon-lg icon-red "</span><span class="kw">></i></span></span>
<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a><span class="kw"><i</span> <span class="er">class</span><span class="ot">=</span><span class="st">"adiba-icon icon-a icon-lg icon-blue "</span><span class="kw">></i></span></span>
<span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a><span class="kw"><i</span> <span class="er">class</span><span class="ot">=</span><span class="st">"adiba-icon icon-s icon-lg icon-yellow "</span><span class="kw">></i></span></span>
<span id="cb3-4"><a href="#cb3-4" aria-hidden="true" tabindex="-1"></a><span class="kw"><i</span> <span class="er">class</span><span class="ot">=</span><span class="st">"adiba-icon icon-h icon-lg icon-purple"</span><span class="kw">></i></span></span>
<span id="cb3-5"><a href="#cb3-5" aria-hidden="true" tabindex="-1"></a><span class="kw"><i</span> <span class="er">class</span><span class="ot">=</span><span class="st">"adiba-icon icon-e icon-lg icon-green"</span><span class="kw">></i></span></span>
<span id="cb3-6"><a href="#cb3-6" aria-hidden="true" tabindex="-1"></a><span class="kw"><i</span> <span class="er">class</span><span class="ot">=</span><span class="st">"adiba-icon icon-d icon-lg icon-orange"</span><span class="kw">></i></span></span></code></pre></div>
<img src="./img/demo.png">
<h1 id="contributing">Contributing</h1>
<p>If you'd like to contribute to the library by adding new icons or
improving existing ones, please follow our contribution guidelines.</p>
</div>
</div>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js"></script>
</body>
</html>