forked from sButtons/sbuttons
-
Notifications
You must be signed in to change notification settings - Fork 0
/
getStarted.html
304 lines (283 loc) · 16.7 KB
/
getStarted.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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
<!doctype html>
<html lang="en">
<head>
<title>sButtons - Simple and Creative Buttons</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<link rel="icon" type="image/png" href="favicon.png">
<link href="https://fonts.googleapis.com/css2?family=Syne:wght@400;500;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Oleo+Script+Swash+Caps:wght@400;700&display=swap"
rel="stylesheet">
<link href="assets/css/index.css" rel="stylesheet" />
<link href="assets/css/getStarted.css" rel="stylesheet" />
<link href="assets/css/sidebar.css" rel="stylesheet" />
<link href="assets/css/variables.css" rel="stylesheet" />
<link href="dist/sbuttons.css" rel="stylesheet" />
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.14.0/css/all.css"
integrity="sha384-HzLeBuhoNPvSl5KYnjx0BT+WB0QEEqLprO+NBkkk5gbc67FTaL7XIGa2w1L0Xbgc" crossorigin="anonymous">
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css"
integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.21.0/themes/prism.min.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/animate.css/4.1.1/animate.min.css" />
<!-- seo friendly og tags-->
<meta name="description" content="Simple buttons you can use easily for your next project.">
<meta name="keywords"
content="css, less, buttons, simple, project, github, open source, contribute, first timers, animation, hover, basic, social, login">
<meta name="og:url" content="https://sButtons.github.io/sbuttons/">
<meta name="og:description" content="Simple buttons you can use easily for your next project.">
<meta name="og:image" content="site logo url">
<meta name="og:type" content="website">
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-149400351-4"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() {
dataLayer.push(arguments);
}
gtag('js', new Date());
gtag('config', 'UA-149400351-4');
</script>
</head>
<body>
<div class="shade"></div>
<header>
<div class="navbar fixed-top">
<button type="button" class="sidebar-toggler d-none d-block d-md-none">
<i class="fas fa-bars"></i>
</button>
<div class="logo">
<img src="assets/img/sbuttons-nav.png" class="img-fluid" />
</div>
<div class="buttons">
<a class="toggle-theme" href="#toggleTheme" title="Toggle light/dark mode">
<i class="fas fa-moon"></i>
</a>
<a href="#" id="downloadGithubRawHeader" class="download-link">
<i class="fas fa-download"></i>
</a>
<a href="https://github.com/sButtons/sbuttons" target="_blank" class="icon-link">
<i class="fab fa-github"></i>
</a>
</div>
</div>
<div class="content">
<div class="logo">
<a href="index.html"><img src="assets/img/sbuttons.png" class="img-fluid" /></a>
</div>
<div class="subtitle">
Simple buttons you can use easily for your next project.
</div>
<a href="#" id="downloadGithubRawButton" class="banner-link down-link">Download</a>
<a href="index.html" class="banner-link">Examples</a>
</div>
</header>
<div class="container mt-5">
<div class="row">
<div class="col-md-3 d-md-block">
<div class="hide-sidebar sidebar animate__animated animate__slideInLeft">
<button class="close-sidebar d-none d-block d-md-none"><i class="fas fa-times-circle"></i></button>
<div class="instructions-sidebar">
<a href="#install" class="install has-children-links">Installation</a>
<div class="submenu-links">
<a href="#downloadcss" class="submenu-link">Download CSS File</a>
<a href="#cdn" class="submenu-link">Install with CDN</a>
<a href="#npm" class="submenu-link">Install with NPM</a>
</div>
<a href="#usage" class="usage has-children-links">Usage</a>
<div class="submenu-links">
<a href="#modify" class="submenu-link">Modify Button Colors</a>
<a href="#basic" class="submenu-link">Basic Button</a>
<a href="#block" class="submenu-link">Block Button</a>
<a href="#disabled" class="submenu-link">Disabled Button</a>
<a href="#icon" class="submenu-link">Icon Button</a>
</div>
</div>
</div>
</div>
<div class="col-md-9 col-12">
<div id="how-to-use">
<h1 class="section-header">Getting Started with sButtons</h1>
<div class="instructions">
<h2 id="install">Installation</h2>
<section class="instruction-block" id="downloadcss">
<h2>Download CSS File</h2>
<hr class="secondary-hr" />
<div class="text">
You can download the CSS file
<a href="#" id="downloadGithubRawHowTo" class="cssLink" target="blank">here</a> and then add it to your
html file in between the tags.
</div>
<div class="text">
Download the file and link it as a stylesheet in between your <span class="code-text"><head></span>
tags, as shown below.
</div>
<br>
<div class="code-block-container ">
<div class="script-copy">
<pre><code class="language-markup"> <link rel="stylesheet" href="/path/to/sbuttons.min.css"></code></pre>
<div class="div-copy"><button class="clipboard"></button></div>
</div>
<br>
</div>
<div class="text">
Make sure to replace
<span class="code-text">"/path/to/sbuttons.min.css"</span> with the path you stored it in.
</div>
<br>
</section>
<section class="instruction-block" id="cdn">
<h2>CDN</h2>
<hr class="secondary-hr" />
<div class="text">
Or instead of downloading the file, you can use the CDN
</div>
<br>
<div class="code-block-container">
<div class="script-copy">
<pre><code class="language-markup"> <link rel="stylesheet" href="https://cdn.statically.io/gh/sButtons/sbuttons/c135f5f7/dist/sbuttons.min.css"></code></pre>
<div class="div-copy"><button class="clipboard"></button></div>
</div>
<br>
</div>
<div class="text">
In case of using buttons that have icons in them, make sure to include font awesome's CDN in the <span
class="code-text"><head></span> tag.
</div>
<div class="code-block-container">
<div class="script-copy">
<pre><code class="language-markup"><link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.14.0/css/all.css" integrity="sha384-HzLeBuhoNPvSl5KYnjx0BT+WB0QEEqLprO+NBkkk5gbc67FTaL7XIGa2w1L0Xbgc" crossorigin="anonymous"></code></pre>
<div class="div-copy"><button class="clipboard"></button></div>
</div>
</div>
<br>
</section>
<section class="instruction-block" id="npm">
<h2>NPM</h2>
<hr class="secondary-hr" />
<div class="text">
You can install sButtons using NPM:
</div>
<div class="code-block-container">
<div class="script-copy">
<pre><code class="language-markup">npm i sbuttons</code></pre>
<div class="div-copy"><button class="clipboard"></button></div>
</div>
</div>
<div class="text">
And then you can import the CSS file found in <span class="code-text">dist/sbuttons.css</span> or the LESS file found in <span class="code-text">src/sbuttons.less</span>.
</div>
<br />
</section>
<h2 id="usage">Usage</h2>
<section class="instruction-block" id="modify">
<h2>Modifying Button Colors</h2>
<hr class="secondary-hr" />
<div class="text">
<p>To modify button colors, import <span class="code-text">src/sbuttons.less</span> in your Less file, then make changes to the variables after the import.</p>
<p>For example, to change the blue color to a different shade</p>
</div>
<div class="code-block-container">
<div class="script-copy">
<pre><code class="language-markup">import '/path/to/sbuttons.less';</code></pre>
<pre><code class="language-markup">@blue: #54a2bd; /* Make it darker */</code></pre>
<div class="div-copy"><button class="clipboard"></button></div>
</div>
</div>
<div class="text">
Check out <a href="https://github.com/sButtons/sbuttons/blob/master/src/sbuttons.less" target="_blank">sbuttons.less</a> for the full list of variables.
</div>
</section>
<section class="instruction-block" id="basic">
<h2 class="display-inlineBlock">Basic Button</h2>
<button class="sbtn basic-btn blue-btn display-inlineBlock margin-left--half">Button</button>
<hr class="secondary-hr" />
<div class="text">
To use sButtons in your project, just add the classes of sButton you want to either
<span class="code-text"><button></span>
or
<span class="code-text"><a></span> tags
</div>
<div class="code-block-container">
<div class="script-copy">
<pre><code class="language-markup"><button class="sbtn basic-btn blue-btn">Button</button></code></pre>
<div class="div-copy"><button class="clipboard"></button></div>
</div>
</div>
<div class="text">
You can find all classes and their corresponding sButtons mentioned in our <a href="https://sButtons.github.io/sbuttons/">website</a>.
</div>
<br>
</section>
<section class="instruction-block" id="block">
<h2>Block Buttons</h2>
<button class="sbtn basic-btn blue-btn block-btn">Button</button>
<hr class="secondary-hr" />
<div class="text">
To use sButtons with block display, add the class to either <span class="code-text"><button></span> or <span class="code-text"><a></span> tags
</div>
<div class="code-block-container">
<div class="script-copy">
<pre><code class="language-markup"><button class="sbtn basic-btn block-btn">Button</button></code></pre>
<div class="div-copy"><button class="clipboard"></button></div>
</div>
</div>
<br />
</section>
<section class="instruction-block" id="disabled">
<h2 class="display-inlineBlock">Disabled Buttons</h2>
<button class="sbtn basic-btn blue-btn disabled-btn display-inlineBlock margin-left--half">Button</button>
<hr class="secondary-hr" />
<div class="text">
To make a <span class="code-text"><button></span> or <span class="code-text"><a></span> tag disabled, add disabled-btn class as shown below.
</div>
<div class="code-block-container">
<div class="script-copy">
<pre><code class="language-markup"><button class="sbtn basic-btn blue-btn disabled-btn">Button</button></code></pre>
<pre><code class="language-markup"><a class="sbtn basic-btn blue-btn disabled-btn">Button</a></code></pre>
<div class="div-copy"><button class="clipboard"></button></div>
</div>
</div>
<br />
</section>
<section class="instruction-block" id="icon">
<h2 class="display-inlineBlock">Icon Buttons</h2>
<button class="sbtn add-to-cart-btn blue-btn display-inlineBlock margin-left--half">Button</button>
<hr class="secondary-hr" />
<div class="text">
In case of using buttons that have icons in them, make sure to include font awesome's <a href="https://use.fontawesome.com/releases/v5.14.0/css/all.css">CDN</a> in the <span class="code-text"><head></span> tag:
</div>
<div class="code-block-container">
<div class="script-copy">
<pre><code class="language-markup"><link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.14.0/css/all.css" integrity="sha384-HzLeBuhoNPvSl5KYnjx0BT+WB0QEEqLprO+NBkkk5gbc67FTaL7XIGa2w1L0Xbgc" crossorigin="anonymous"></code></pre>
<div class="div-copy"><button class="clipboard"></button></div>
</div>
</div>
<br />
</section>
</div>
</div>
<!-- Button examples will go here using JS -->
</div>
</div>
</div>
<span class="scroll-top" data-scroll="up" style="display: none;">
<i class="fa fa-chevron-circle-up" aria-hidden="true"></i>
</span>
<footer class="footer">
<span class="tagline">Made with <span style="color: floralwhite" class="tagline-heart">❤︎</span></span><br/>
<div style="padding: 20px 0">Say Hello to our awesome <a href="https://github.com/sButtons/sbuttons/blob/master/CONTRIBUTORS.md">contributors</a>!<br/>
Have any suggestions or want to contribute?
<a href="https://github.com/sButtons/sbuttons" target="_blank" title="View on Github">View on Github</a></div>
<div style="padding:20px 0 0 0; font-size: 13px;">Logo made by <a href="https://www.github.com/icoderharshit"
title="Harshit Sharma">Harshit Sharma</a> </div>
</footer>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.21.0/components/prism-core.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.21.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://code.jquery.com/jquery-3.5.1.min.js"
integrity="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js" integrity="sha384-ZMP7rVo3mIykV+2+9J3UJ46jBk0WLaUAdn689aCwoqbBJiSnjAK/l8WvCWPIPm49" crossorigin="anonymous"></script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/js/bootstrap.min.js" integrity="sha384-ChfqqxuZUCnJSK3+MXmPNIyE6ZbWh2IMqE241rYiqJxyMiZ6OW/JmZQ5stwEULTy" crossorigin="anonymous"></script>
<script src="assets/js/buttons-examples.js"></script>
<script src="assets/js/index.js"></script>
</body>
</html>