-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
711 lines (634 loc) · 24 KB
/
index.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
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
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
<!-- DOCUMENTATION LAYOUT -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="description" content="">
<meta name="keywords" content="">
<title>Docthebuilder | Introduction</title>
<!-- Styles -->
<link rel="stylesheet" href="https://docthebuilder.thecodestudio.xyz/space/css/font-awesome.css">
<link rel="stylesheet" href="https://docthebuilder.thecodestudio.xyz/doc_theme/documentation/theme_one/css/page.css">
<link rel="stylesheet" href="https://docthebuilder.thecodestudio.xyz/doc_theme/documentation/theme_one/css/style.css">
<!-- Favicons -->
<link rel="apple-touch-icon" href="https://docthebuilder.thecodestudio.xyz/favicon.png">
<link rel="icon" href="https://docthebuilder.thecodestudio.xyz/favicon.png">
</head>
<script>
"use strict"
function myStyle() {
var leftSidebarUl = document.querySelector('.left-sidebar ul');
leftSidebarUl.classList.add('h5');
var rightSidebarUl = document.querySelector('.right-sidebar ul');
rightSidebarUl.classList.add('toc');
}
// JavaScript function to show the preloader
window.addEventListener('load', () => {
myStyle();
const preloader = document.getElementById("preloader");
setTimeout(() => {
preloader.style.display = "none";
}, 1000); // 1 second delay
});
</script>
<body>
<div id="preloader">
<script src="https://cdn.lordicon.com/fudrjiwc.js"></script>
<lord-icon
src="https://cdn.lordicon.com/ggqtvqxi.json"
trigger="loop"
colors="primary:#121331,secondary:#104891"
style="width:250px;height:250px">
</lord-icon> </div>
<!-- Navbar -->
<nav class="navbar navbar-expand-lg navbar-dark navbar-stick-dark" data-navbar="static">
<div class="container">
<div class="navbar-left">
<button class="navbar-toggler" type="button">☰</button>
<a class="navbar-brand text-dark" href="">
Docthebuilder </a>
<span class="text-monospace d-md-none d-xl-none">
v1.0 </span>
<span class="d-md-none d-xl-none ml-6 position-relative">
<form class="w-100">
<div class="input-group b-0 focus">
<div class="input-group-prepend">
<span class="input-group-text"><i class="ti-search"></i></span>
</div>
<input type="text" class="form-control" id="searchInputMobile" placeholder="Search documentation ...">
</div>
</form>
<ul class="list-group" id="searchResultsMobile">
<!-- search results goes here -->
</ul>
</span>
</div>
<section class="navbar-mobile">
<span class="navbar-divider d-mobile-none"></span>
<ul class="nav nav-navbar">
<li class="nav-item text-monospace">
v1.0 </li>
</ul>
</section>
<section class="navbar-mobile position-relative d-mobile-none">
<form class="w-100">
<div class="input-group b-0 focus">
<div class="input-group-prepend">
<span class="input-group-text"><i class="ti-search"></i></span>
</div>
<input type="text" class="form-control" id="searchInput" placeholder="Search documentation ...">
</div>
</form>
<ul class="list-group" id="searchResults">
<!-- search results will appear here -->
</ul>
</section>
<a class="d-mobile-none text-monospace w-100 text-right text-muted font-weight-bold" href="https://thecodestudioxyz.github.io" target="_blank">
<img src="https://docthebuilder.thecodestudio.xyz/favicon.png" alt="The Code Studio" class="w25">
Powered By DocTheBuilder </a>
</div>
</nav><!-- /.navbar -->
<!-- Main Content -->
<main class="main-content">
<div class="container">
<div class="row">
<div class="col-md-3 col-xl-3">
<hr class="d-md-none my-0">
<aside class="sidebar sidebar-expand-md sidebar-sticky pr-md-4 br-1 left-sidebar">
<ul>
<li>
<a href="introduction.md">Introduction</a>
</li>
<li>
<a href="server-requirements.md">Server Requirements</a>
</li>
<li>
<a href="installation-steps.md">Installation Steps</a>
</li>
<li>
<a href="sign-in-credential.md">Sign in Credential</a>
</li>
<li>
<a href="usage.md">Usage</a>
</li>
<li>
<a href="support.md">Support</a>
</li>
</ul>
</aside>
</div>
<div class="col-md-7 col-xl-7 ml-md-auto py-6">
<div class="middle-content">
<h1><a class="permalink" href="?doc=cd804eb4#docthebuilder-documentation-builder-and-amp-book-publishing-saas-application"><span>#</span></a><a class="anchor" id="docthebuilder-documentation-builder-and-amp-book-publishing-saas-application"></a>DocTheBuilder - Documentation Builder & Book Publishing SaaS Application</h1>
<h1><a class="permalink" href="?doc=cd804eb4#stronggetting-started-strong"><span>#</span></a><a class="anchor" id="stronggetting-started-strong"></a><strong>Getting Started</strong></h1>
<p><strong>Attention:</strong></p>
<p>This documentation you are reading is built with DocTheBuilder.</p>
<h2><a class="permalink" href="?doc=cd804eb4#strongintroduction-strong"><span>#</span></a><a class="anchor" id="strongintroduction-strong"></a><strong>Introduction</strong></h2>
<p>DocTheBuilder is a powerful documentation builder and book publishing SaaS application that allows users to create professional-grade documentation with no coding required. Whether you're a technical writer or a non-technical user familiar with tools like MS Word or Google Docs, DocTheBuilder makes it easy to create and publish high-quality documentation. With its export options, including HTML and PDF, you can easily share your work with others and even include a live preview feature. DocTheBuilder is the perfect tool for anyone looking to create professional-grade documentation with ease. DocTheBuilder also offers a Software as a Service (SaaS) feature, allowing users to access the application and all its features through the cloud. This means that users can access their documentation and work on it from anywhere, at any time, as long as they have an internet connection. The SaaS feature also allows for easy collaboration and team-based work, as multiple users can access and edit the same document simultaneously. With its SaaS feature, DocTheBuilder makes it easy to create and publish professional-grade documentation on the go.</p>
</div>
<div class="row">
<div class="col-md-12">
<a href="https://thecodestudioxyz.github.io/v1.0/docthebuilder/server-requirements">
<div class="card border">
<div class="card-body d-flex justify-content-between">
<div>
<small class="text-muted">Next</small>
<br>
<span class="text-dark h6">Server Requirements</span>
</div>
<div class="icon-center">
<i class="fa fa-long-arrow-right text-dark"></i>
</div>
</div>
</div>
</a>
</div>
</div>
</div>
<div class="col-md-2 col-xl-2">
<hr class="d-md-none my-0">
<aside class="sidebar right-sidebar">
<strong class="h6 fs-14 font-weight-bold">ON THIS PAGE</strong>
<ul class="nav-level-0">
<li>
<a href="#docthebuilder-documentation-builder-and-amp-book-publishing-saas-application">DocTheBuilder - Documentation Builder & Book Publishing SaaS Application</a>
</li>
<li>
<a href="#stronggetting-started-strong"><strong>Getting Started</strong></a>
<ul class="nav-level-1">
<li>
<a href="#strongintroduction-strong"><strong>Introduction</strong></a>
</li>
</ul>
</li>
</ul>
</aside>
</div>
</div>
</div>
</main><!-- /.main-content -->
<!-- Footer -->
<footer class="footer py-5 text-center text-lg-center">
<div class="container">
<div class="row gap-y">
<div class="col-lg-12 text-center">
<p>
<a href="">
Docthebuilder </a><br>
© 2023 Powered By
<a href="https://thecodestudioxyz.github.io" target="_blank" class="font-weight-bold">
<img src="https://thecodestudioxyz.github.io/favicon.png" alt="The Code Studio" class="w25">
DocTheBuilder </a>
</p>
</div>
</div>
</div>
</footer><!-- /.footer -->
<input type="hidden" value="/home2/thecode/docthebuilder.thecodestudio.xyz/files/docthebuilder/docthebuilder.json" id="space_json_path">
<input type="hidden" value="https://thecodestudioxyz.github.io/v1.0/docthebuilder/" id="site_url">
<!-- Scripts -->
<script src="https://docthebuilder.thecodestudio.xyz/js/fuse.js"></script>
<script src="https://docthebuilder.thecodestudio.xyz/doc_theme/documentation/theme_one/js/page.js"></script>
<script>
"use strict"
var path = location.pathname;
var parts = path.split(/[\\/.]+/);
var baseName = parts.pop();
/**
* It splits the url into an array of parts, then returns the last part of the array
*
* @return The last part of the url.
*/
function getLastPart(url) {
const parts = url.split('/');
return parts.at(-1);
}
const links = document.querySelectorAll('a[href]');
/* Replacing the .md extension with .html extension. */
if (baseName == 'html') {
links.forEach(link => {
link.href = getLastPart(link.href).replace(/\.md$/, '') + '.html';
});
}else {
links.forEach(link => {
link.href = link.href.replace(/\.md$/, '');
});
}
// Search
/* Searching through the array of objects and returning the name and description of the object
that matches the search term. */
$('#searchInput').on('keyup', function() {
var searchTerm = $(this).val();
var space_json_path = $('#space_json_path').val();
var site_url = $('#site_url').val();
var data = {
"_sidebar.md": [
{
"level": 0,
"text": "Introduction",
"link": "introduction.md"
},
{
"level": 0,
"text": "Server Requirements",
"link": "server-requirements.md"
},
{
"level": 0,
"text": "Installation Steps",
"link": "installation-steps.md"
},
{
"level": 0,
"text": "Sign in Credential",
"link": "sign-in-credential.md"
},
{
"level": 0,
"text": "Usage",
"link": "usage.md"
},
{
"level": 0,
"text": "Support",
"link": "support.md"
}
],
"installation-steps.md": [
{
"level": 1,
"text": "Installation Steps",
"link": "#installationsteps"
},
{
"level": 2,
"text": "Step 1",
"link": "#step1"
},
{
"level": 2,
"text": "Step 2",
"link": "#step2"
},
{
"level": 2,
"text": "Step 3",
"link": "#step3"
},
{
"level": 2,
"text": "Step 4",
"link": "#step4"
},
{
"level": 2,
"text": "Step 5",
"link": "#step5"
},
{
"level": 2,
"text": "Important Notice",
"link": "#importantnotice"
}
],
"introduction.md": [
{
"level": 1,
"text": "DocTheBuilder - Documentation Builder & Book Publishing SaaS Application",
"link": "#docthebuilderdocumentationbuilderbookpublishingsaasapplication"
},
{
"level": 1,
"text": "Getting Started",
"link": "#gettingstarted"
},
{
"level": 2,
"text": "Introduction",
"link": "#introduction"
}
],
"server-requirements.md": [
{
"level": 1,
"text": "Server Requirements",
"link": "#serverrequirements"
}
],
"sign-in-credential.md": [
{
"level": 1,
"text": "Sign in Credential",
"link": "#signincredential"
}
],
"signin-credential.md": [
{
"level": 1,
"text": "Sign in Credential",
"link": "#signincredential"
}
],
"support.md": [
{
"level": 1,
"text": "Support",
"link": "#support"
},
{
"level": 2,
"text": "Overview",
"link": "#overview"
},
{
"level": 2,
"text": "Contact us",
"link": "#contactus"
}
],
"usage.md": [
{
"level": 1,
"text": "Usage",
"link": "#usage"
},
{
"level": 1,
"text": "How to create space?",
"link": "#howtocreatespace"
},
{
"level": 2,
"text": "How to write?",
"link": "#howtowrite"
},
{
"level": 2,
"text": "How to Publish?",
"link": "#howtopublish"
},
{
"level": 2,
"text": "Front-End",
"link": "#frontend"
},
{
"level": 2,
"text": "Multi-Currency",
"link": "#multicurrency"
}
]
};
var options = {
keys: ['text']
};
var fuse = new Fuse(Object.values(data).reduce((acc, val) => acc.concat(val), []), options);
var searchTerm = $(this).val();
var filteredData = fuse.search(searchTerm);
$('#searchResults').empty();
/* The above code is taking the search results and displaying them in the search results section. */
filteredData.forEach(function(result) {
result = result.item;
var re = new RegExp(searchTerm, 'gi');
var highlightedText = result.text.replace(re, '<mark>'+searchTerm+'</mark>');
var parentKey = Object.keys(data).find(key => data[key].includes(result));
/* Checking to see if the parent key is not equal to the sidebar.md file. */
if(parentKey !== "_sidebar.md"){
if (baseName == 'html') {
var parentKey = parentKey.replace('.md','.html');
var result_link = result.link.replace('.md','.html');
var href = parentKey + result_link;
}else{
var parentKey = parentKey.replace('.md','');
var result_link = result.link.replace('.md','');
var href = site_url + parentKey + result_link;
}
$('#searchResults').append('<li class="list-group-item search-li" onclick="RedirectTo(this)" data-link="' + href + '">' + highlightedText + '</li>');
} else {
if (baseName == 'html') {
var parentKey = parentKey.replace('.md','.html');
var result_link = result.link.replace('.md','.html');
var href = result_link;
}else{
var parentKey = parentKey.replace('.md','');
var result_link = result.link.replace('.md','');
var href = site_url + result_link;
}
$('#searchResults').append('<li class="list-group-item search-li" onclick="RedirectTo(this)" data-link="' + href + '">' + highlightedText + '</li>');
}
});
});
// For Mobile
$('#searchInputMobile').on('keyup', function() {
var searchTerm = $(this).val();
var space_json_path = $('#space_json_path').val();
var site_url = $('#site_url').val();
var data = {
"_sidebar.md": [
{
"level": 0,
"text": "Introduction",
"link": "introduction.md"
},
{
"level": 0,
"text": "Server Requirements",
"link": "server-requirements.md"
},
{
"level": 0,
"text": "Installation Steps",
"link": "installation-steps.md"
},
{
"level": 0,
"text": "Sign in Credential",
"link": "sign-in-credential.md"
},
{
"level": 0,
"text": "Usage",
"link": "usage.md"
},
{
"level": 0,
"text": "Support",
"link": "support.md"
}
],
"installation-steps.md": [
{
"level": 1,
"text": "Installation Steps",
"link": "#installationsteps"
},
{
"level": 2,
"text": "Step 1",
"link": "#step1"
},
{
"level": 2,
"text": "Step 2",
"link": "#step2"
},
{
"level": 2,
"text": "Step 3",
"link": "#step3"
},
{
"level": 2,
"text": "Step 4",
"link": "#step4"
},
{
"level": 2,
"text": "Step 5",
"link": "#step5"
},
{
"level": 2,
"text": "Important Notice",
"link": "#importantnotice"
}
],
"introduction.md": [
{
"level": 1,
"text": "DocTheBuilder - Documentation Builder & Book Publishing SaaS Application",
"link": "#docthebuilderdocumentationbuilderbookpublishingsaasapplication"
},
{
"level": 1,
"text": "Getting Started",
"link": "#gettingstarted"
},
{
"level": 2,
"text": "Introduction",
"link": "#introduction"
}
],
"server-requirements.md": [
{
"level": 1,
"text": "Server Requirements",
"link": "#serverrequirements"
}
],
"sign-in-credential.md": [
{
"level": 1,
"text": "Sign in Credential",
"link": "#signincredential"
}
],
"signin-credential.md": [
{
"level": 1,
"text": "Sign in Credential",
"link": "#signincredential"
}
],
"support.md": [
{
"level": 1,
"text": "Support",
"link": "#support"
},
{
"level": 2,
"text": "Overview",
"link": "#overview"
},
{
"level": 2,
"text": "Contact us",
"link": "#contactus"
}
],
"usage.md": [
{
"level": 1,
"text": "Usage",
"link": "#usage"
},
{
"level": 1,
"text": "How to create space?",
"link": "#howtocreatespace"
},
{
"level": 2,
"text": "How to write?",
"link": "#howtowrite"
},
{
"level": 2,
"text": "How to Publish?",
"link": "#howtopublish"
},
{
"level": 2,
"text": "Front-End",
"link": "#frontend"
},
{
"level": 2,
"text": "Multi-Currency",
"link": "#multicurrency"
}
]
};
var options = {
keys: ['text']
};
var fuse = new Fuse(Object.values(data).reduce((acc, val) => acc.concat(val), []), options);
var searchTerm = $(this).val();
var filteredData = fuse.search(searchTerm);
$('#searchResultsMobile').empty();
/* The above code is taking the search results and displaying them in the search results section. */
filteredData.forEach(function(result) {
result = result.item;
var re = new RegExp(searchTerm, 'gi');
var highlightedText = result.text.replace(re, '<mark>'+searchTerm+'</mark>');
var parentKey = Object.keys(data).find(key => data[key].includes(result));
/* Checking to see if the parent key is not equal to the sidebar.md file. */
if(parentKey !== "_sidebar.md"){
if (baseName == 'html') {
var parentKey = parentKey.replace('.md','.html');
var result_link = result.link.replace('.md','.html');
var href = parentKey + result_link;
}else{
var parentKey = parentKey.replace('.md','');
var result_link = result.link.replace('.md','');
var href = site_url + parentKey + result_link;
}
$('#searchResultsMobile').append('<li class="list-group-item search-li" onclick="RedirectTo(this)" data-link="' + href + '">' + highlightedText + '</li>');
} else {
if (baseName == 'html') {
var parentKey = parentKey.replace('.md','.html');
var result_link = result.link.replace('.md','.html');
var href = result_link;
}else{
var parentKey = parentKey.replace('.md','');
var result_link = result.link.replace('.md','');
var href = site_url + result_link;
}
$('#searchResultsMobile').append('<li class="list-group-item search-li" onclick="RedirectTo(this)" data-link="' + href + '">' + highlightedText + '</li>');
}
});
});
/**
* It takes the data-link attribute of the list item that was clicked and sets the
* window.location.href to that value
*/
function RedirectTo(li) {
window.location.href = li.getAttribute('data-link');
}
</script>
</body>
</html>
<!-- DOCUMENTATION LAYOUT::ENDS -->