-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocumentation.html
More file actions
597 lines (595 loc) · 38.2 KB
/
documentation.html
File metadata and controls
597 lines (595 loc) · 38.2 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
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
<!DOCTYPE html>
<!--
Item Name: Mfundopedia - Web App & Admin Dashboard Template
Author: Ignatius Mutizwa
** A license must be purchased in order to legally use this template for your project **
-->
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Mfundopedia - Documentation</title>
<meta name="description" content="Mfundopedia is a Web App and Admin Dashboard Template built with Bootstrap 4">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- Google Fonts -->
<script src="https://ajax.googleapis.com/ajax/libs/webfont/1.6.26/webfont.js"></script>
<script>
WebFont.load({
google: {"families":["Montserrat:400,500,600,700","Noto+Sans:400,700"]},
active: function() {
sessionStorage.fonts = true;
}
});
</script>
<!-- Favicon -->
<link rel="apple-touch-icon" sizes="180x180" href="../assets/img/apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="32x32" href="../assets/img/favicon-32x32.png">
<link rel="icon" type="image/png" sizes="16x16" href="../assets/img/favicon-16x16.png">
<!-- Stylesheet -->
<link rel="stylesheet" href="../assets/vendors/css/base/bootstrap.min.css">
<link rel="stylesheet" href="../assets/vendors/css/base/Elisyam-1.5.min.css">
<link rel="stylesheet" href="css/Elisyam-bundle.css">
<link rel="stylesheet" href="css/prism.css">
<!-- Tweaks for older IEs--><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script><![endif]-->
</head>
<body id="page-top">
<div class="page bg-white">
<!-- Begin Header -->
<header class="header fixed-top">
<div class="container">
<nav class="navbar no-shadow">
<!-- Begin Topbar -->
<div class="navbar-holder d-flex align-items-center align-middle justify-content-between">
<!-- Begin Logo -->
<div class="navbar-header mr-auto">
<a href="full-screen-preview.html" class="navbar-brand">
<div class="brand-image"><img src="img/logo.png" alt="logo" class="logo-small"></div>
</a>
</div>
<!-- End Logo -->
</div>
<!-- End Topbar -->
</nav>
</div>
</header>
<!-- End Header -->
<!-- Begin Page Content -->
<div class="page-content">
<!-- Begin Content -->
<div class="content-inner boxed w-100">
<!-- Begin Jumbotron -->
<div class="jumbotron j-documentation jumbotron-fluid d-flex align-items-center text-center">
<div class="container">
<h2>Mfundopedia Documentation</h2>
</div>
</div>
<!-- End Jumbotron -->
<div class="container mt-5">
<div class="row">
<div class="col-xl-2 col-lg-2 col-md-2">
<ul class="left-nav nav nav-pills flex-column mb-3" data-toggle="sticky-onscroll">
<li class="nav-item">
<a class="js-scrollTo nav-link" href="#intro">Introduction</a>
</li>
<li class="nav-item">
<a class="js-scrollTo nav-link" href="#install">Installation</a>
</li>
<li class="nav-item">
<a class="js-scrollTo nav-link" href="#structure">Structure</a>
</li>
<li class="nav-item">
<a class="js-scrollTo nav-link" href="#dark-version">Dark Version</a>
</li>
<li class="nav-item">
<a class="js-scrollTo nav-link" href="#fonts">Fonts</a>
</li>
<li class="nav-item">
<a class="js-scrollTo nav-link" href="#icons">Icons</a>
</li>
<li class="nav-item">
<a class="js-scrollTo nav-link" href="#widgets">Widgets</a>
</li>
<li class="nav-item">
<a class="js-scrollTo nav-link" href="#mplayer">Music Player</a>
</li>
<li class="nav-item">
<a class="js-scrollTo nav-link" href="#utilities">Utilities</a>
</li>
<li class="nav-item">
<a class="js-scrollTo nav-link" href="#references">References</a>
</li>
</ul>
</div>
<div class="col-xl-10 col-lg-10 col-md-10">
<div class="widget has-shadow">
<div id="intro">
<div class="widget-header bordered no-actions d-flex align-items-center">
<h2>Introduction</h2>
</div>
<div class="widget-body text-dark">
<p>Mfundopedia is the complete package that was built to help you create a custom and unique user interface for your project.</p>
<p>With Mfundopedia you’re not limited to creating a single page for your admin panel. You’ll have over many pre-built page templates to choose from, covering many popular scenarios and content types. Like the main admin demos, all the page templates are highly customizable.</p>
<p>You can add any of the pre-built UI elements to your design. The options are vast, with elements including buttons, badges, widgets, timeline, modals, progress bars, and more. They can all be customized to ensure they fit in or contrast with the rest of your dashboard as desired.</p>
<p>Mfundopedia is packed with pages that come complete with documented code to simplify the customization process.</p>
<p>Author: Ignatius Mutizwa</p>
<p class="text-info">Mfundopedia supports all modern browsers (Chrome, Firefox, Safari) including Edge.</p>
</div>
</div>
<div id="install">
<div class="widget-header bordered no-actions d-flex align-items-center">
<h2>Installation</h2>
</div>
<div class="widget-body text-dark">
<p>Mfundopedia is a simple static HTML template so it's simple to install it.</p>
<p>Just simple steps to follow:</p>
<p>
HTML Files + assets
</p>
</div>
</div>
<div id="structure">
<div class="widget-header bordered no-actions d-flex align-items-center">
<h2>Folder Structure</h2>
</div>
<div class="widget-body text-dark">
<pre><code>HTML
├── assets
| └── css
| | └── all css files
| |
| └── icons
| | └── all icons files
| |
| └── img
| | └── all img files
| |
| └── js
| | └── all javascript files
| |
| └── vendors
| └── all vendors css/javascript files
|
└── all html files
</code></pre>
</div>
</div>
<div id="dark-version">
<div class="widget-header bordered no-actions d-flex align-items-center">
<h2>Dark Version</h2>
</div>
<div class="widget-body text-dark">
<p>All pages of Mfundopedia are available in dark version.</p>
<p>Just change the name of the css file: <code>Elisyam-1.0.css</code> by <code>Elisyam-1.0-dark.css</code>.</p>
<p>Same thing for javascript files: <code>file.js</code> by <code>file-dark.js</code>.</p>
<p>Add .min for minified files.</p>
</div>
</div>
<div id="fonts">
<div class="widget-header bordered no-actions d-flex align-items-center">
<h2>Fonts</h2>
</div>
<div class="widget-body text-dark">
<p>We used google fonts, so you can change them easily.</p>
<pre class="language-javascript">
<code>
<script>
WebFont.load({
google: {"families":["Montserrat:400,500,600,700","Noto+Sans:400,700"]},
active: function() {
sessionStorage.fonts = true;
}
});
</script>
</code>
</pre>
<p>Default Fonts: <a href="https://fonts.google.com/specimen/Montserrat">Montserrat</a> and <a href="https://fonts.google.com/specimen/Noto+Sans">Noto Sans</a></p>
<p><a href="https://fonts.google.com/">Google Fonts</a></p>
</div>
</div>
<div id="icons">
<div class="widget-header bordered no-actions d-flex align-items-center">
<h2>Icons</h2>
</div>
<div class="widget-body text-dark">
<p>LineAwesome - <code><i class="la la-icon"></i></code></p>
<p>Themify - <code><i class="ti ti-icon"></i></code></p>
<p>Ionicons - <code><i class="ion-icon"></i></code></p>
<p>Meteocons - <code><i class="meteocons-icon"></i></code></p>
</div>
</div>
<div id="widgets">
<div class="widget-header bordered no-actions d-flex align-items-center">
<h2>Widgets</h2>
</div>
<div class="widget-body text-dark">
<p>Basic widget structure</p>
<pre class="language-markup">
<code>
<div class="widget has-shadow">
<div class="widget-header">
<h2>Widget Header</h2>
</div>
<div class="widget-body">
Content Body
</div>
<div class="widget-footer">
Content Footer
</div>
</div>
</code>
</pre>
<div class="widget-header bordered no-actions d-flex align-items-center">
<h2>Widget Header With Border</h2>
</div>
<pre class="language-markup">
<code>
<div class="widget-header bordered no-actions d-flex align-items-center">
<h2>Widget Header With Border</h2>
</div>
</code>
</pre>
<div class="widget-header no-actions d-flex align-items-center">
<h2>Widget Header No Border</h2>
</div>
<pre class="language-markup">
<code>
<div class="widget-header bordered no-actions d-flex align-items-center">
<h2>Widget Header No Border</h2>
</div>
</code>
</pre>
<div class="widget-header bordered d-flex align-items-center">
<h2>Widget Header With Actions</h2>
<div class="widget-options">
<div class="dropdown">
<button type="button" id="actions" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false" class="dropdown-toggle">
<i class="la la-ellipsis-h"></i>
</button>
<div aria-labelledby="Actions" class="dropdown-menu">
<a href="#" class="dropdown-item">
Options 1
</a>
<a href="#" class="dropdown-item">
Options 2
</a>
<a href="#" class="dropdown-item">
Options 3
</a>
</div>
</div>
</div>
</div>
<pre class="language-markup">
<code>
<div class="widget-header bordered no-actions d-flex align-items-center">
<h2>Widget Header With Border</h2>
<div class="widget-options">
<div class="dropdown">
<button type="button" id="actions" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false" class="dropdown-toggle">
<i class="la la-ellipsis-h"></i>
</button>
<div aria-labelledby="Actions" class="dropdown-menu">
<a href="#" class="dropdown-item">
Options 1
</a>
<a href="#" class="dropdown-item">
Options 2
</a>
<a href="#" class="dropdown-item">
Options 3
</a>
</div>
</div>
</div>
</div>
</code>
</pre>
<div class="widget-header bordered no-actions d-flex align-items-center">
<h2>Widget Header With Button</h2>
<div class="widget-options">
<div class="btn-group" role="group">
<button type="button" class="btn btn-primary">Button 1</button>
<button type="button" class="btn btn-primary">Button 2</button>
</div>
</div>
</div>
<pre class="language-markup">
<code>
<div class="widget-header bordered no-actions d-flex align-items-center">
<h2>Widget Header With Border</h2>
<div class="widget-options">
<div class="btn-group" role="group">
<button type="button" class="btn btn-primary">Button 1</button>
<button type="button" class="btn btn-primary">Button 2</button>
</div>
</div>
</div>
</code>
</pre>
</div>
</div>
<div id="mplayer">
<div class="widget-header bordered no-actions d-flex align-items-center">
<h2>Music Player</h2>
</div>
<div class="widget-body">
<p>
assets > js > music > music-player.js
</p>
<p class="text-dark">You can add multiple files, to change just press the previous and next buttons on the player.</p>
<p class="text-dark">Some examples below:</p>
<pre class="language-javascript">
<code>
songs = [{
src: "folder/Song Example.mp3", // mp3 file
title: "Artist/Group Name - Song Name", // Title
coverart: "assets/img/music/img.jpg" // Image
}, {
src: "folder/song example.mp3",
title: "Artist/Group Name - Song Name",
coverart: "assets/img/music/img.jpg"
}, {
src: "folder/song-example.mp3",
title: "Artist/Group Name - Song Name",
coverart: "assets/img/music/img.jpg"
}, ];
</code>
</pre>
</div>
</div>
<div id="utilities">
<div class="widget-header bordered no-actions d-flex align-items-center">
<h2>Utilities</h2>
</div>
<div class="widget-body">
<p><a href="https://getbootstrap.com/docs/4.0/utilities/borders/" target="_blank">Bootstrap Utilities</a></p>
<p class="text-dark">Text Color</p>
<table class="table table-bordered">
<thead>
<tr>
<th>Class</th>
<th>Results</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>.text-primary</code></td>
<td class="text-primary">Lorem ipsum dolor sit amet consectecur.</td>
</tr>
<tr>
<td><code>.text-secondary</code></td>
<td class="text-secondary">Lorem ipsum dolor sit amet consectecur.</td>
</tr>
<tr>
<td><code>.text-success</code></td>
<td class="text-success">Lorem ipsum dolor sit amet consectecur.</td>
</tr>
<tr>
<td><code>.text-info</code></td>
<td class="text-info">Lorem ipsum dolor sit amet consectecur.</td>
</tr>
<tr>
<td><code>.text-warning</code></td>
<td class="text-warning">Lorem ipsum dolor sit amet consectecur.</td>
</tr>
<tr>
<td><code>.text-danger</code></td>
<td class="text-danger">Lorem ipsum dolor sit amet consectecur.</td>
</tr>
<tr>
<td><code>.text-gradient-01</code></td>
<td class="text-gradient-01">Lorem ipsum dolor sit amet consectecur.</td>
</tr>
<tr>
<td><code>.text-gradient-02</code></td>
<td class="text-gradient-02">Lorem ipsum dolor sit amet consectecur.</td>
</tr>
<tr>
<td><code>.text-gradient-03</code></td>
<td class="text-gradient-03">Lorem ipsum dolor sit amet consectecur.</td>
</tr>
<tr>
<td><code>.text-gradient-04</code></td>
<td class="text-gradient-04">Lorem ipsum dolor sit amet consectecur.</td>
</tr>
<tr>
<td><code>.text-gradient-05</code></td>
<td class="text-gradient-05">Lorem ipsum dolor sit amet consectecur.</td>
</tr>
<tr>
<td><code>.text-dark</code></td>
<td class="text-dark">Lorem ipsum dolor sit amet consectecur.</td>
</tr>
</tbody>
</table>
<p class="text-dark mt-5">Background Color</p>
<table class="table table-bordered">
<thead>
<tr>
<th>Class</th>
<th>Results</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>.bg-primary</code></td>
<td class="bg-primary"></td>
</tr>
<tr>
<td><code>.bg-secondary</code></td>
<td class="bg-secondary"></td>
</tr>
<tr>
<td><code>.bg-success</code></td>
<td class="bg-success"></td>
</tr>
<tr>
<td><code>.bg-info</code></td>
<td class="bg-info"></td>
</tr>
<tr>
<td><code>.bg-warning</code></td>
<td class="bg-warning"></td>
</tr>
<tr>
<td><code>.bg-danger</code></td>
<td class="bg-danger"></td>
</tr>
<tr>
<td><code>.bg-dark</code></td>
<td class="bg-dark"></td>
</tr>
<tr>
<td><code>.bg-white</code></td>
<td class="bg-white"></td>
</tr>
<tr>
<td><code>.bg-gradient-01</code></td>
<td class="bg-gradient-01"></td>
</tr>
<tr>
<td><code>.bg-gradient-02</code></td>
<td class="bg-gradient-02"></td>
</tr>
<tr>
<td><code>.bg-gradient-03</code></td>
<td class="bg-gradient-03"></td>
</tr>
<tr>
<td><code>.bg-gradient-04</code></td>
<td class="bg-gradient-04"></td>
</tr>
<tr>
<td><code>.bg-gradient-05</code></td>
<td class="bg-gradient-05"></td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="references">
<div class="widget-header bordered no-actions d-flex align-items-center">
<h2>References</h2>
</div>
<div class="widget-body">
<p class="text-dark">Text Color</p>
<table class="table table-bordered">
<thead>
<tr>
<th>Term</th>
<th>Website</th>
</tr>
</thead>
<tbody class="text-dark">
<tr>
<td>Animate</td>
<td><a href="https://daneden.github.io/animate.css/" target="_blank">https://daneden.github.io/animate.css/</a></td>
</tr>
<tr>
<td>Bootstrap</td>
<td><a href="https://getbootstrap.com/" target="_blank">https://getbootstrap.com</a></td>
</tr>
<tr>
<td>Bootstrap Select</td>
<td><a href="https://github.com/VinceG/twitter-bootstrap-wizard" target="_blank">https://github.com/VinceG/twitter-bootstrap-wizard</a></td>
</tr>
<tr>
<td>Bootstrap Wizard</td>
<td><a href="https://github.com/VinceG/twitter-bootstrap-wizard" target="_blank">https://github.com/VinceG/twitter-bootstrap-wizard</a></td>
</tr>
<tr>
<td>Chart Js</td>
<td><a href="https://www.chartjs.org/" target="_blank">https://www.chartjs.org/</a></td>
</tr>
<tr>
<td>Circle Progress</td>
<td><a href="https://kottenator.github.io/jquery-circle-progress/" target="_blank">https://kottenator.github.io/jquery-circle-progress/</a></td>
</tr>
<tr>
<td>Countdown</td>
<td><a href="https://hilios.github.io/jQuery.countdown/" target="_blank">https://hilios.github.io/jQuery.countdown/</a></td>
</tr>
<tr>
<td>Full Calendar</td>
<td><a href="https://fullcalendar.io/" target="_blank">https://fullcalendar.io/</a></td>
</tr>
<tr>
<td>Google Fonts</td>
<td><a href="https://fonts.google.com/" target="_blank">https://fonts.google.com/</a></td>
</tr>
<tr>
<td>Ionicons</td>
<td><a href="https://ionicons.com/" target="_blank">https://ionicons.com/</a></td>
</tr>
<tr>
<td>Leaflet</td>
<td><a href="https://leafletjs.com/" target="_blank">https://leafletjs.com/</a></td>
</tr>
<tr>
<td>LineAwesome</td>
<td><a href="https://icones8.fr/line-awesome" target="_blank">https://icones8.fr/line-awesome</a></td>
</tr>
<tr>
<td>Lity</td>
<td><a href="https://sorgalla.com/lity/" target="_blank">https://sorgalla.com/lity/</a></td>
</tr>
<tr>
<td>Meteocons</td>
<td><a href="https://www.alessioatzeni.com/meteocons/" target="_blank">https://www.alessioatzeni.com/meteocons/</a></td>
</tr>
<tr>
<td>Nicescroll</td>
<td><a href="https://nicescroll.areaaperta.com/" target="_blank">https://nicescroll.areaaperta.com/</a></td>
</tr>
<tr>
<td>Noty</td>
<td><a href="https://ned.im/noty/#/" target="_blank">https://ned.im/noty/#/</a></td>
</tr>
<tr>
<td>Owl Carousel 2</td>
<td><a href="https://owlcarousel2.github.io/OwlCarousel2/index.html" target="_blank">https://owlcarousel2.github.io/OwlCarousel2/index.html</a></td>
</tr>
<tr>
<td>Shutterstock</td>
<td><a href="https://www.shutterstock.com/" target="_blank">https://www.shutterstock.com/</a></td>
</tr>
<tr>
<td>Themify</td>
<td><a href="https://themify.me/themify-icons" target="_blank">https://themify.me/themify-icons</a></td>
</tr>
<tr>
<td>Unsplash</td>
<td><a href="https://unsplash.com/" target="_blank">https://unsplash.com/</a></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
</div>
<footer class="footer">
<div class="container text-center">
<img src="img/logo.png" alt="logo" class="footer-logo mx-auto">
<p class="text-dark">Copyright © 2022 - Designed by Ignatius Mutizwa</p>
</div>
</footer>
</div>
<!-- End Content -->
</div>
<!-- End Page Content -->
</div>
<!-- Begin Vendor Js -->
<script src="../assets/vendors/js/base/jquery.min.js"></script>
<script src="../assets/vendors/js/base/core.min.js"></script>
<!-- End Vendor Js -->
<!-- Begin Page Vendor Js -->
<script src="../assets/vendors/js/app/app.js"></script>
<!-- End Page Vendor Js -->
<script src="js/Elisyam.js"></script>
<script src="js/prism.js"></script>
</body>
</html>