-
Notifications
You must be signed in to change notification settings - Fork 0
/
documentation.html
301 lines (293 loc) · 13.9 KB
/
documentation.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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>StyleForge Documentation</title>
<link rel="stylesheet" href="./css/index.css">
</head>
<body>
<nav class="navbar justify-between">
<div class="container">
<h1 class="site-title text-lightblue"><a href="homepage.html">StyleForge</a></h1>
<ul class="display-f">
<li class="ml-1 text-hover-yellowish pr-2"><a href="documentation.html">Documentation</a></li>
<li class="ml-1 text-hover-yellowish pl-2"><a href="index.html">Examples</a></li>
</ul>
</div>
</nav>
<div class="container mt-3">
<div class="row justify-space-around">
<div class="col-12-sm col-6-lg">
<h2>
<div class="font-xxl">StyleForge</div>
<div class="font-xxl text-pinkish">How to use it?</div>
</h2>
<p class="text-gray mt-2 mb-3">Lets take a look at how to use this awesome tool!</p>
</div>
<div class="col-12-sm col-6-lg">
<h1 class="text-center text-pinkish"> Here is what we'll go through:</h1>
<ul class="ml-5 pl-2 font-lg">
<li class="m-3 text-yellowish"> Colours </li>
<li class="m-3 text-yellowish"> Utilities</li>
<li class="m-3 text-yellowish"> Grid</li>
<li class="m-3 text-yellowish"> Components</li>
<li class="m-3 text-yellowish"> buttons</li>
</ul>
</div>
</div>
<h1 class="text-lightblue text-center"> Using Colours </h1>
<div class="row gap-2 justify-space-around">
<div class="col-12-xs col-6-lg">
<div class="card">
<h3 class="card-title">Text Colour</h3>
<p class="card-body">To use one of our colours on the font please use: text-colourname</p>
</div>
</div>
<div class="col-12-xs col-6-lg">
<div class="card">
<h3 class="card-title">Text Hover</h3>
<p class="card-body">To make your text change colours on mouse hover over please use: text-hover-colourname</p>
</div>
</div>
<div class="col-12-xs col-6-lg">
<div class="card">
<h3 class="card-title">Background Colours</h3>
<p class="card-body">To make change the colour of an elements background please use: bg-colourname.</p>
</div>
</div>
<div class="col-12-xs col-6-lg">
<div class="card">
<h3 class="card-title">Border Colours</h3>
<p class="card-body">To change the colour of an elements border please use: border-colourname.</p>
</div>
</div>
</div>
<h3 class="text-pinkish text-center mt-1"> Available Colours </h3>
<div class="row gap-2">
<div class="col-12-xs">
<div class="card">
<h3 class="card-title">List of Colours</h3>
<p class="card-body"> Keep in mind this list can be modified in the colours map.</p>
<ul class="display-f">
<li class="text-primary">Primary</li>
<li class="text-Secondary ml-2">Secondary</li>
<li class="text-error ml-2">Error</li>
<li class="text-blue ml-2">Blue</li>
<li class="text-red ml-2">Red</li>
<li class="text-yellow ml-2">Yellow</li>
<li class="text-green ml-2">Green</li>
<li class="text-orange ml-2">Orange</li>
<li class="text-purple ml-2">Purple</li>
<li class="text-gray ml-2">Gray</li>
<li class="text-black ml-2">Black</li>
<li class="text-white ml-2 bg-black">White</li>
<li class="text-pinkish ml-2">Pinkish</li>
<li class="text-yellowish ml-2">Yellowish</li>
<li class="text-lightblue ml-2">Lightblue</li>
</ul>
</div>
</div>
</div>
<div class="row gap-2 justify-space-around">
<div class="col-12-xs col-6-lg">
<div class="card">
<h3 class="card-title">Lighten Colours</h3>
<p class="card-body">To get a slightly lighter version of a colour use this: thing-colourname-light-1/---/9</p> </div>
</div>
<div class="col-12-xs col-6-lg">
<div class="card">
<h3 class="card-title">Darken Colours</h3>
<p class="card-body">To get a slightly darker version of a colour use this: thing-colourname-dark-1/---/9</p>
</div>
</div>
</div>
<h1 class="text-lightblue text-center mt-3"> Utility Classes </h1>
<div class="row gap-2 justify-center">
<div class="col-12-xs col-6-lg">
<div class="card">
<h3 class="card-title">Padding</h3>
<p class="card-body">To place padding on an item use the following:</p>
<p class="card-body">p/pl/pr/pb/pt - 1/2/3/4/5</p>
<p class="card-body">all/left/right/bottom/top</p>
</div>
</div>
<div class="col-12-xs col-6-lg">
<div class="card">
<h3 class="card-title">Margin</h3>
<p class="card-body">To place padding on an item use the following:</p>
<p class="card-body">m/ml/mr/mb/mt - 1/2/3/4/5</p>
<p class="card-body">all/left/right/bottom/top</p>
</div>
</div>
</div>
<div class="row gap-2 justify-center">
<div class="col-12-xs">
<div class="card">
<h3 class="card-title">Opacity</h3>
<p class="card-body">To change the opacity of an element please use the following:</p>
<p class="card-body">o-10/----/100</p>
</div>
</div>
</div>
<!-- -->
<div class="row gap-2 justify-center">
<div class="col-12-xs col-4-lg">
<div class="card">
<h3 class="card-title">Border Radius</h3>
<p class="card-body">To place padding on an item use the following:</p>
<p class="card-body">br-default/none/xs/sm/lg/full</p>
</div>
</div>
<div class="col-12-xs col-4-lg">
<div class="card">
<h3 class="card-title">Border Width</h3>
<p class="card-body">To modify the border width of an item use the following:</p>
<p class="card-body">bw - 1/2/3/4/5/10/25</p>
<p class="card-body">1px --- 25px</p>
</div>
</div>
<div class="col-12-xs col-4-lg">
<div class="card">
<h3 class="card-title">Border Style</h3>
<p class="card-body">To modify the border style of an item use the following:</p>
<p class="card-body">bs - s/da/do/g/r</p>
<p class="card-body">solid/dashed/dotted/groove/ridge</p>
</div>
</div>
</div>
<div class="row gap-2 justify-center">
<div class="col-12-xs col-6-lg">
<div class="card">
<h3 class="card-title">Font Size</h3>
<p class="card-body">To change the size of text use the following:</p>
<p class="card-body">font-size - sm/md/lg/xl</p>
</div>
</div>
<div class="col-12-xs col-6-lg">
<div class="card">
<h3 class="card-title">Display</h3>
<p class="card-body">To apply different display properties use the following:</p>
<p class="card-body">display-n/f/b/i/i-o</p>
<p class="card-body">none/flex/block/inline/inline-block</p>
</div>
</div>
</div>
<h1 class="text-lightblue text-center mt-3"> Grid </h1>
<div class="row gap-2 justify-center">
<div class="col-12-xs">
<div class="card">
<h3 class="card-title">Getting started</h3>
<p class="card-body">To get started create a div with a class of container</p>
<p class="card-body">Then create divs with the class of row to define the rows you want your grid split into </p>
<p class="card-body">Each row will stretch a standard 12 columns.</p>
</div>
</div>
</div>
<div class="row gap-2 justify-center">
<div class="col-12-xs">
<div class="card">
<h3 class="card-title">Columns</h3>
<p class="card-body">Inside your rows define your content inside divs with classes set up like this to determine how much space they take up.</p>
<p class="card-body">class = "col-n-breakpoint</p>
<p class="card-body">n can be any number less than 12. If n is 12 the div will take up 100% percent of the row. If n is 6 the div will take up 50% of the row. And so on ... </p>
<p> The breakpoint is the screen width at which you want this size of the div to take effect. Breakpoint options are xs,sm,md,lg,xl. You can define a size for the dive at all the breakpoints</p>
<p>Take a look at the example below by changing the size of your screen.</p>
</div>
</div>
</div>
<div class="row gap-2 justify-center">
<div class="col-3-xs col-4-sm col-6-md col-8-lg col-12-xl">
<div class="card">
<h3 class="card-title">Columns</h3>
<p class="card-body">This will take up 3 cols on xs screens, 4 on sm, 6 on md, 8 on lg and 12 on xl!</p>
</div>
</div>
</div>
<div class="row gap-2 justify-center">
<div class="col-12-xs col-6-lg">
<div class="card">
<h3 class="card-title">Column Gap</h3>
<p class="card-body">To add a gap inbetween the divs of your rows use this on your row div:</p>
<p class="card-body">class= "row gap-n"</p>
<p class="card-body">n can be between 1 and 5.</p>
</div>
</div>
<div class="col-12-xs col-6-lg">
<div class="card">
<h3 class="card-title">Justifying Space</h3>
<p class="card-body">To determine where the empty space in your rows is place use this on your row div:</p>
<p class="card-body">class = "row justify-options</p>
<p class="card-body">option can be flex-start/flex-end/space-between/space-around.</p>
</div>
</div>
</div>
<h1 class="text-lightblue text-center mt-3"> Components </h1>
<div class="row gap-2 justify-center">
<h3 class="text-pinkish text-center mt-1"> Navbars </h1>
<div class="col-12-xs">
<div class="card">
<h3 class="card-title">Working with Navbars</h3>
<p class="card-body">Start with a nav with a class of navbar.</p>
<p class="card-body">Inside make a title with a class of site-title.</p>
<p class="card-body">Lastly, add some other elements and use display-f to place them next to each other inside the nav.</p>
<p class="card-body">Then, customize!!!</p>
</div>
</div>
</div>
<div class="row gap-2 justify-center">
<h3 class="text-pinkish text-center mt-1"> Cards </h1>
<div class="col-12-xs">
<div class="card">
<h3 class="card-title">Working with Cards</h3>
<p class="card-body">Cards are what this documentation page is built from!</p>
<p class="card-body">To create a card place you content inside a div with a class of card</p>
<p class="card-body">Inside there create your card title with a class of card-title and any body text with a class of card-body</p>
<p class="card-body">Then, customize!!!</p>
</div>
</div>
</div>
<div class="row gap-2 justify-center">
<h3 class="text-pinkish text-center mt-1"> Badges </h1>
<div class="col-12-xs">
<div class="card">
<h3 class="card-title">Working with Badges <span class="badge-yellowish text-white ml-1">WOAHHHHHHhhhhhhhhhhhhhhhhhhhhhhhhhh</span></h3>
<p class="card-body">Start with a nav with a class of navbar.</p>
<p class="card-body">Badges are the fun thing you see above!</p>
<p class="card-body">To create on make a span with a class of badge-colourname</p>
<p class="card-body">Pcik a colour from our documentation and add your text inside the span!</p>
</div>
</div>
</div>
<h1 class="text-lightblue text-center mt-3"> Buttons </h1>
<div class="row gap-2 justify-center">
<div class="col-12-xs col-4-lg">
<div class="card">
<h3 class="card-title">Basic Button</h3>
<p class="card-body">To create a basic button and style it add a class of the following form:.</p>
<p class="card-body">class = "btn-colourname" </p>
</div>
</div>
<div class="col-12-xs col-4-lg">
<div class="card">
<h3 class="card-title">Button Outline</h3>
<p class="card-body">To create an outlined button add a class of the following form:</p>
<p class="card-body">class = "btn-outline-colourname"</p>
</div>
</div>
<div class="col-12-xs col-4-lg">
<div class="card">
<h3 class="card-title">Compliment Buttons</h3>
<p class="card-body">To create a funky looking compliment button add a class of the following form:</p>
<p class="card-body">class = "btn-compliment-colourname" </p>
</div>
</div>
</div>
</div>
<footer class="bg-gray-dark-7 pt-3 pb-3 mt-5">
<div class="container">
<p class="text-yellowish">copyright 2024 StyleForge css</p>
</div>
</footer>
</body>
</html>