-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathgetting-started.html
More file actions
423 lines (380 loc) · 24.3 KB
/
getting-started.html
File metadata and controls
423 lines (380 loc) · 24.3 KB
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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
<!DOCTYPE html>
<html lang="en">
<head>
<title>Getting started with ChuckCSS | Responsive CSS framework and CSS helpers tools</title>
<meta name="description" content="ChuckCSS is a flexible, adaptative, mobile-first and easy to learn CSS framework. ChuckCSS included an advanced and responsive grid system based on the CSS3 flexbox property" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no">
<meta name="google-site-verification" content="DBdJ6J16-N5CeTy47NhyCMkP4kagIa5a1YsQvKuKm9A" />
<meta name="author" content="Mickaël SURREL, ALPIXEL agency and ChuckCSS contributors">
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<link rel="icon" href="favicon.ico" />
<link rel="apple-touch-icon" sizes="180x180" href="apple-touch-icon.png">
<link rel="icon" type="image/png" href="img/favicons/favicon-32x32.png" sizes="32x32">
<link rel="icon" type="image/png" href="img/favicons/favicon-16x16.png" sizes="16x16">
<link rel="manifest" href="img/favicons/manifest.json">
<link rel="mask-icon" href="img/favicons/safari-pinned-tab.svg">
<meta name="theme-color" content="#2fc0aa">
<link href="https://fonts.googleapis.com/css?family=Roboto:300,400,700" rel="stylesheet">
<link rel="stylesheet" href="//pro.fontawesome.com/releases/v5.1.0/css/all.css" integrity="sha384-87DrmpqHRiY8hPLIr7ByqhPIywuSsjuQAfMXAE0sMUpY3BM7nXjf+mLIUSvhDArs" crossorigin="anonymous">
<link rel="stylesheet" href="//code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css" crossorigin="anonymous">
<link rel="stylesheet" href="dist/front.min.css" type="text/css" media="screen" />
<script type="text/javascript">
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-9271946-14', 'auto');
ga('send', 'pageview');
</script>
<!-- Place this tag in your head or just before your close body tag. -->
<script async defer src="https://buttons.github.io/buttons.js"></script>
<script type="application/ld+json">
{
"@context": "http://schema.org",
"@type": "BreadcrumbList",
"itemListElement": [
{
"@type": "ListItem",
"position": 1,
"item": {
"@id": "http://chuckcss.io",
"name": "ChuckCSS"
}
},
{
"@type": "ListItem",
"position": 2,
"item": {
"@id": "http://chuckcss.io/getting-started",
"name": "Getting started with ChuckCSS"
}
}
]
}
</script>
</head>
<body class="getting-started" data-spy="scroll" data-target="#left-navbar" data-offset="400">
<!-- COOKIES -->
<div id="cookies">
<i class="fa fa-exclamation-circle"></i> Our website use cookies to work properly. By browsing our website you understand cookies will be used on your computer.
<a href="#" class="accept-cookie close btn cc-bg-blue">I understand</a>
</div>
<header id="main-header">
<!-- Hamburger for phone devices -->
<div class="open-menu">
<button class="hamburger hamburger--elastic" type="button">
<span class="hamburger-box">
<span class="hamburger-inner"></span>
</span>
</button>
</div>
<nav class="inside js-nav">
<ul>
<li class="first">
<a href="index">
<img src="img/logo-chuckcss-small.png" alt="ChuckCSS framework : responsive CSS framework" />
</a>
</li>
<li>
<a href="getting-started" class="active">Getting started</a>
</li>
<li>
<a href="documentation">Documentation</a>
</li>
<li>
<a href="reminder">Reminder</a>
</li>
<li>
<a href="https://github.com/alpixel/ChuckCSS" rel="nofollow" class="external-link">Download</a>
</li>
<li class="last">
<a href="https://twitter.com/chuckcss" rel="nofollow" class="external-link btn"><i class="fab fa-twitter icon-left"></i>Follow me on Twitter</a>
</li>
</ul>
</nav>
</header>
<main>
<section class="page-presentation">
<canvas id="anim-bg-1" class="anim-bg"></canvas>
<div class="inside">
<h1>Getting started with ChuckCSS</h1>
</div>
</section>
<div class="cc-hidden-l cc-txt-center phone-menu cc-pa">
<a href="#" class="btn cc-bg-primary cc-w-50">Jump to...<i class="fa fa-angle-right"></i></a>
</div>
<section class="inside">
<div class="columns">
<aside class="cc-3-l menu-summary">
<p class="close-summary-menu cc-hidden-l">
<a href="#">
<i class="ion-android-close"></i>
</a>
</p>
<div id="left-navbar">
<h3>Getting started</h3>
<ul class="nav" role="tablist">
<li class="active">
<a href="#start-download">
Download ChuckCSS
</a>
</li>
<li class="active">
<a href="#start-jsdelivr">
Use a CDN
</a>
</li>
<li>
<a href="#start-tree-files">
ChuckCSS tree files
</a>
</li><li>
<a href="#start-source-files">
Working with source files
</a>
</li>
</ul>
</div>
</aside>
<section class="cc-12 cc-9-l">
<div class="wrap-feature">
<h2 id="start-download">
<a href="#start-download">
<i class="ion-link icon-left"></i>
Download ChuckCSS
</a>
</h2>
<div class="columns cc-txt-center">
<div>
<p>NPM Package</p>
<a href="https://www.npmjs.com/package/ChuckCSS" rel="nofollow" class="btn external-link black">
$ npm install ChuckCSS
</a>
</div>
<div>
<p>
YARN package
</p>
<a href="https://yarnpkg.com/en/package/ChuckCSS" rel="nofollow" class="btn external-link black">
$ yarn add ChuckCSS
</a>
</div>
<div>
<p>GitHub repository</p>
<a class="github-button" href="https://github.com/alpixel/ChuckCSS/archive/master.zip" rel="nofollow" data-size="large" aria-label="Download alpixel/ChuckCSS on GitHub">Download from GitHub</a>
</div>
</div>
</div>
<div class="wrap-feature">
<h2 id="start-jsdelivr">
<a href="#start-jsdelivr"><i class="ion-link icon-left"></i>
Use ChuckCSS with a CDN (Content Delivery Network)
</a>
</h2>
<div class="alert alert-info">
<div>
ChuckCSS is available on jsDelivr : <a href="https://www.jsdelivr.com/package/npm/ChuckCSS" rel="nofollow" class="external-link">https://www.jsdelivr.com/package/npm/ChuckCSS</a>
</div>
</div>
<pre class="HTML">
<code class="language-markup"><!-- -->
<!-- Include the ChuckCSS CSS file -->
<link media="screen" rel="stylesheet" href="https://cdn.jsdelivr.net/npm/ChuckCSS/dist/chuckcss.min.css" integrity="sha384-9Q5efsUnTOxxKSBqSr+Xu5C6NhT9C7ZpXmOJlQDLWsN43EpVBS1C/uqmwfuJJdw4" crossorigin="anonymous">
<!-- ** OPTIONNAL ** -->
<!-- Print file -->
<link media="print" rel="stylesheet" href="https://cdn.jsdelivr.net/npm/ChuckCSS/dist/print.css" integrity="sha384-v3V621jdwau+HZBAsgh1A2BAbGS203f9aH7aedLd1AIWLQYDnluBvLmdMkgkN3hU" crossorigin="anonymous">
<!-- ** OPTIONNAL ** -->
<!-- Just before the </body> close tag, include the ChuckCSS JS file -->
<!-- The javascript file is optionnal. It manages modals (openings and closures) and alerts (closures) -->
<!-- You can easily create your own javascript file to manage by yourself modals and alerts -->
<script src="https://cdn.jsdelivr.net/npm/ChuckCSS/dist/chuckcss.js" integrity="sha384-ADz7aKD9VLw6IBaYl8pwAckpQVIk9vjGsvvNtj3lPPWWgcgu9ZgvNnR+AP7oz7x+" crossorigin="anonymous" defer></script>
</code>
</pre>
</div>
<div class="wrap-feature">
<h2 id="start-tree-files">
<a href="#start-tree-files"><i class="ion-link icon-left"></i>
ChuckCSS tree files
</a>
</h2>
<pre class="HTML">
<code class="language-markup"><!-- -->
<!-- ChuckCSS tree files -->
chuckcss/
|
├── front-light.less <!-- all @imports, light version of ChuckCSS -->
├── front.less <!-- all @imports, base file of ChuckCSS -->
├── print.less <!-- print.css source file -->
├── settings-light.less <!-- all variables definitions for light version -->
├── settings.less <!-- all variables definitions -->
|
├── components/
├──────── alerts.less
├──────── badges.less
├──────── grids.less
├──────── modals.less
├──────── tabs.less
|
├── main/
├──────── animations.less <!-- radio, checkbox, loaders animations -->
├──────── base.less <!-- <html> and <body> general definitions -->
├──────── functions.less <!-- powerful mixins file -->
├──────── generator-light.less <!-- light generator classes... -->
├──────── generator.less <!-- grids items width, texts helpers... -->
├──────── helpers.less <!-- block helpers : visibility, width... -->
├──────── icons.less <!-- simple icons placement -->
├──────── normalize.less <!-- reset css -->
├──────── responsive.less <!-- responsive mixins -->
|
├── elements/
├──────── blockquotes.less
├──────── buttons.less
├──────── forms.less
├──────── images.less
├──────── lists.less
├──────── loaders.less
├──────── tables.less
└──────── titles.less
</code>
</pre>
</div>
<div class="wrap-feature">
<h2 id="start-source-files">
<a href="#start-source-files"><i class="ion-link icon-left"></i>
Working with source files
</a>
</h2>
<div class="alert alert-info">
<div>
Working with source files give you the possibility to customize ChuckCSS with your own settings, colors, etc... but you have to be familiar with <a rel="nofollow" href="http://lesscss.org/" class="external-link">Less language.</a><br /><br />
<strong>By compiling your own dist file with <a href="https://gruntjs.com/" rel="nofollow" class="external-link">Grunt</a> or <a href="https://gulpjs.com/" class="external-link">Gulp</a>, combined with <a href="https://github.com/postcss/autoprefixer" rel="nofollow" class="external-link">Autoprefixer</a>,</strong> you can use powerfull mixins to build websites easily and faster.
<ul>
<li>
<a href="https://gulpjs.com/" rel="nofollow" class="external-link">Gulp documentation</a>
</li>
<li>
<a href="http://gruntjs.com/getting-started" rel="nofollow" class="external-link">Grunt documentation</a>
</li>
<li>
<a href="https://github.com/postcss/autoprefixer" rel="nofollow" class="external-link">Autoprefixer documentation</a> : ChuckCSS uses Autoprefixer to deal with CSS vendor prefixes. If you use the Gulpfile.js downloaded with ChuckCSS, Autoprefixer is already include. If you use your own Gruntfile or Gulpfile, integrate Autoprefixer by yourself.
</li>
</ul>
</div>
</div>
<p class="cc-mat-50">
Assuming your local project get a tree like that :
</p>
<pre class="HTML">
<code class="language-markup"><!-- -->
<!-- Your local project files -->
local-project/
|
| ...somes files and folders...
|
├── less/
├──────── main.less
└──────── my-own-settings.less
</code>
</pre>
<p class="cc-mat-20">
In your <strong>main.less</strong> file, include the <strong>front.less</strong> from ChuckCSS dist repository, and <strong>your own settings file</strong>.
</p>
<pre class="HTML language-less">
<code class="language-less"><!-- -->
/* main.less */
@charset "UTF-8";
// Import front.less of front-light.less (if you want to work without grids) file from ChuckCSS
@import "./node_modules/ChuckCSS/chuckcss/front";
// You can create your own settings file, to override ChuckCSS settings
@import "my-own-settings";
// Now you can use all ChuckCSS mixins, animations, class, etc...
p {
._reset; // <-- ._reset() is a ChuckCSS mixin (defined into functions.less)
background-color: @red; // <-- You can use ChuckCSS predefined colors (defined into native ChuckCSS settings.less file or into your own settings file my-own-settings.less)
._transition; // <-- ._transition() is a ChuckCSS mixin (animate smoothly when the element state changes) (defined into functions.less)
// or use a custom animation with parameters
._transition(0.6s, background-color, linear, 0.5s);
&:hover {
background-color: @green; // <-- background-color will change smoothly on hover
}
}
</code>
</pre>
<p class="cc-mat-20">
Now you can <strong>override the ChuckCSS default settings</strong>, with your own values, by adding variables into your settings file.
</p>
<pre class="HTML language-less">
<code class="language-less"><!-- -->
/* exemple of my-own-settings.less */
/*
* Extend the ChuckCSS settings.less file *
*** OVERRIDE CHUCKCSS VARS ***
* Specific vars
*/
/*
-- @ Class prefix @ --
*/
@css-prefix: yolo; // Change the prefix class
// Now you can use your own class 'yolo-txt-center', 'yolo-inside'.. and all usefull ChuckCSS class
/*
-- @ Colors @ --
*/
/* Primary color */
@primary: #29b7e1;
@primary-na: primary; /* Name of the color, for @aColors array */
// Green
@green: #80ae37;
@green-na: green; /* Name of the color, for @aColors array */
// red
@red: #c41515;
@red-na: red; /* Name of the color, for @aColors array */
// gray
@gray: #bababa;
// blue
@blue: #3498db;
@blue-na: blue; /* Name of the color, for @aColors array */
// Colors array: Add any color you want \m/
// array(@color1-name @color1-value, @color2-name @color2-value,...);
@aColors:
@primary-na @primary,
@green-na @green,
@red-na @red,
@blue-na @blue;
/*
-- @ Texts @ --
*/
@text: {
mc: #3a3a3a; /* Texts ~ Main color (hexa, rgb, rgba...) */
fs: 1.6rem; // Font-size && line-height for small screens (<= 359px)
lh: 1.5;
fs-s: 1.6rem; // Font-size && line-height for phone screens (>= 360px)
lh-s: 1.5;
fs-m: 1.6rem; // Font-size && line-height for medium screens (>= 768px)
lh-m: 1.5;
fs-l: 1.6rem; // Font-size && line-height for large screens (>= 989px)
lh-l: 1.5;
fs-xl: 1.6rem; // Font-size && line-height for x-large screens (>= 1200px)
lh-xl: 1.5;
}
</code>
</pre>
</div>
</section>
</div>
</section>
</main>
<footer id="main-footer">
<p>
© 2019 - ChuckCSS.io - All rights reserved - Made with ❤ for <a href="https://www.alpixel.fr" rel="nofollow" class="external-link">ALPIXEL Agency</a>
</p>
<p>
ChuckCSS is under <a rel="nofollow" href="https://opensource.org/licenses/mit-license.php" class="external-link">MIT Licence</a> - <a rel="nofollow" href="https://github.com/alpixel/ChuckCSS" class="external-link">Hosted on GitHub</a>
</p>
</footer>
<!-- Back to top -->
<a href="#main-header" class="backtotop ion-chevron-up"></a>
<script src="https://code.jquery.com/jquery-2.2.4.min.js" integrity="sha256-BbhdlvQf/xTY9gja0Dq3HiwQF8LaCRTXxZKRutelT44=" crossorigin="anonymous"></script>
<script type="text/javascript" src="dist/app.min.js"></script>
</body>
</html>