Skip to content

Commit 0ff4a22

Browse files
committed
documentation page added.
1 parent 67d546c commit 0ff4a22

13 files changed

Lines changed: 251 additions & 53 deletions

File tree

404/index.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,6 @@
4444
<link rel="manifest" href="../static/img/favicons/site.webmanifest" />
4545
<link rel="icon" href="../static/img/favicons/favicon.ico" />
4646

47-
<!-- js -->
48-
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>
49-
5047
<!-- jvectormap -->
5148
<link
5249
rel="stylesheet"
@@ -846,6 +843,8 @@ <h6 class="modal-title">All Applications</h6>
846843

847844
<!-- jquery -->
848845
<script src="https://code.jquery.com/jquery-3.6.4.min.js"></script>
846+
<!-- bootstrap.bundle.min.js -->
847+
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>
849848
<!-- chartjs -->
850849
<script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
851850
<!-- jvectormap -->

blank-page/index.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,6 @@
4444
<link rel="manifest" href="../static/img/favicons/site.webmanifest" />
4545
<link rel="icon" href="../static/img/favicons/favicon.ico" />
4646

47-
<!-- js -->
48-
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>
49-
5047
<!-- jvectormap -->
5148
<link
5249
rel="stylesheet"
@@ -846,6 +843,8 @@ <h6 class="modal-title">All Applications</h6>
846843

847844
<!-- jquery -->
848845
<script src="https://code.jquery.com/jquery-3.6.4.min.js"></script>
846+
<!-- bootstrap.bundle.min.js -->
847+
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>
849848
<!-- chartjs -->
850849
<script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
851850
<!-- jvectormap -->

documentation/index.html

Lines changed: 227 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
<meta name="viewport" content="width=device-width, initial-scale=1" />
1818

19-
<title>Admin Template | Documentation</title>
19+
<title>Admin Template | adminAM Documentation</title>
2020
<!-- <meta http-equiv="refresh" content="5"/> -->
2121

2222
<!-- CSS -->
@@ -44,9 +44,6 @@
4444
<link rel="manifest" href="../static/img/favicons/site.webmanifest" />
4545
<link rel="icon" href="../static/img/favicons/favicon.ico" />
4646

47-
<!-- js -->
48-
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>
49-
5047
<!-- jvectormap -->
5148
<link
5249
rel="stylesheet"
@@ -425,8 +422,230 @@ <h3 class="md-mb-0">Documentation</h3>
425422
<!-- page title ends -->
426423

427424
<div class="row mt-4">
428-
<div class="col">
429-
<h1>Django Dark Admin Template</h1>
425+
<div class="col-lg-12">
426+
<!-- about -->
427+
<section class="my-4">
428+
<p>
429+
This project titled as adminAM is an open source admin
430+
template created by
431+
<a
432+
href="http://127.0.0.1:9002/documentation/www.amaharjan.de"
433+
target="_blank"
434+
class="link-offset-2"
435+
>www.amaharjan.de</a
436+
>
437+
🔗.
438+
</p>
439+
</section>
440+
<div class="divider"></div>
441+
<!-- about ends -->
442+
443+
<!-- quick start -->
444+
<section class="my-4">
445+
<h3>Quick Start</h3>
446+
<p>Jump-start your project with adminAM:</p>
447+
<pre>
448+
<code>
449+
$ mkdir your_project_name
450+
$ cd your_project_name
451+
$ git clone https://github.com/asis2016/bootstrap-5-admin-template.git
452+
</code>
453+
</pre>
454+
</section>
455+
<div class="divider"></div>
456+
<!-- quick start ends -->
457+
458+
<!-- Dependencies & Plugins -->
459+
<section class="my-4">
460+
<h3>Dependencies & Plugins</h3>
461+
<p>
462+
The adminAM depends on the following frameworks and plugins:
463+
</p>
464+
<ul>
465+
<li>
466+
<a
467+
href="https://getbootstrap.com/"
468+
target="_blank"
469+
class="link-offset-2 amj-a"
470+
>
471+
<i class="bi bi-bootstrap me-2"></i> Bootstrap v5.3.2
472+
</a>
473+
</li>
474+
<!-- jQuery -->
475+
<li>
476+
<a
477+
href="index.html#"
478+
target="_blank"
479+
class="link-offset-2 amj-a"
480+
>
481+
<i class="bi bi-filetype-js me-2"></i> jQuery v3.6.4
482+
</a>
483+
</li>
484+
<!-- chart.js -->
485+
<li>
486+
<a
487+
href="https://www.chartjs.org/"
488+
target="_blank"
489+
class="link-offset-2 amj-a"
490+
>
491+
<i class="bi bi-graph-up-arrow me-2"></i> Chart.js v4.4.1
492+
</a>
493+
</li>
494+
<!-- jVectorMap -->
495+
<li>
496+
<a
497+
href="https://jvectormap.com/"
498+
target="_blank"
499+
class="link-offset-2 amj-a"
500+
>
501+
<i class="bi bi-graph-up-arrow me-2"></i> jVectorMap
502+
v2.0.5
503+
</a>
504+
</li>
505+
<!-- plotly -->
506+
<li>
507+
<a
508+
href="https://plotly.com/javascript/"
509+
target="_blank"
510+
class="link-offset-2 amj-a"
511+
>
512+
<i class="bi bi-graph-up-arrow me-2"></i> plotly.js
513+
v1.58.5
514+
</a>
515+
</li>
516+
<!-- Bootstrap Icons v1.11.2 -->
517+
<li>
518+
<a
519+
href="https://icons.getbootstrap.com/"
520+
target="_blank"
521+
class="link-offset-2 amj-a"
522+
>
523+
<i class="bi bi-bootstrap me-2"></i> Bootstrap Icons
524+
v1.11.2
525+
</a>
526+
</li>
527+
<!-- Google fonts -->
528+
<li>
529+
<a
530+
href="https://fonts.google.com/"
531+
target="_blank"
532+
class="link-offset-2 amj-a"
533+
>
534+
<i class="bi bi-fonts me-2"></i> Google Fonts
535+
</a>
536+
</li>
537+
</ul>
538+
</section>
539+
<div class="divider"></div>
540+
<!-- Dependencies & Plugins ends -->
541+
542+
<!-- features/pages -->
543+
<section class="my-4">
544+
<h3>Features / Pages</h3>
545+
<ol>
546+
<li>404 page</li>
547+
<li>Account login page</li>
548+
<li>Account registration page</li>
549+
<li>Blank page</li>
550+
<li>Dashboard page</li>
551+
<li>Mail page</li>
552+
<li>Product page</li>
553+
<ul>
554+
<li>Product list page</li>
555+
<li>Expenses report page</li>
556+
<li>Sales report page</li>
557+
</ul>
558+
<li>Profile page</li>
559+
<li>Search results page</li>
560+
<li>Single page</li>
561+
</ol>
562+
</section>
563+
<div class="divider"></div>
564+
<!-- features/pages ends -->
565+
566+
<!-- license -->
567+
<section class="my-4">
568+
<h3>License</h3>
569+
<p>
570+
<b><i>adminAM - Bootstrap 5 admin template</i></b> is free!
571+
And always remain free. The project is licensed under MIT,
572+
that means:
573+
</p>
574+
<p>Copyright (c) 2024 Ashish S. Maharjan</p>
575+
<p>
576+
Permission is hereby granted, free of charge, to any person
577+
obtaining a copy of this software and associated documentation
578+
files (the "Software"), to deal in the Software without
579+
restriction, including without limitation the rights to use,
580+
copy, modify, merge, publish, distribute, sublicense, and/or
581+
sell copies of the Software, and to permit persons to whom the
582+
Software is furnished to do so, subject to the following
583+
conditions:
584+
</p>
585+
<p>
586+
The above copyright notice and this permission notice shall be
587+
included in all copies or substantial portions of the
588+
Software.
589+
</p>
590+
<p>
591+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
592+
KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
593+
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
594+
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
595+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
596+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
597+
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
598+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
599+
</p>
600+
</section>
601+
<div class="divider"></div>
602+
<!-- license ends -->
603+
604+
<!-- bugs and issues -->
605+
<section class="my-4">
606+
<h3>Bugs and Issues</h3>
607+
<p>
608+
Have a bug or an issue with this template? Please
609+
<a
610+
href="https://github.com/asis2016/bootstrap-5-admin-template/issues"
611+
target="_blank"
612+
class="link-offset-2"
613+
>
614+
Open a new issue
615+
</a>
616+
🔗 on GitHub.
617+
</p>
618+
</section>
619+
<div class="divider"></div>
620+
<!-- bugs and issues ends -->
621+
622+
<!-- contribution -->
623+
<section class="my-4">
624+
<h3>Contributing & Feedback</h3>
625+
<p>
626+
Contributions are always welcome! And, if you have any
627+
feedback or query, please reach out to me at
628+
<a href="mailto:hello@amaharjan.de">hello@amaharjan.de</a>.
629+
</p>
630+
</section>
631+
<div class="divider"></div>
632+
<!-- contribution ends-->
633+
634+
<!-- Buy me a coffee -->
635+
<section class="my-4">
636+
<h3>Buy me a coffee</h3>
637+
<p>
638+
Your gracious contribution through
639+
<a
640+
href="https://www.paypal.com/paypalme/asis2016"
641+
target="_blank"
642+
class="link-offset-2"
643+
>PayPal</a
644+
>
645+
🔗 would very much support the development of this project.
646+
</p>
647+
</section>
648+
<!-- Buy me a coffee ends -->
430649
</div>
431650
</div>
432651

@@ -846,6 +1065,8 @@ <h6 class="modal-title">All Applications</h6>
8461065

8471066
<!-- jquery -->
8481067
<script src="https://code.jquery.com/jquery-3.6.4.min.js"></script>
1068+
<!-- bootstrap.bundle.min.js -->
1069+
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>
8491070
<!-- chartjs -->
8501071
<script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
8511072
<!-- jvectormap -->

expenses/index.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,6 @@
4444
<link rel="manifest" href="../static/img/favicons/site.webmanifest" />
4545
<link rel="icon" href="../static/img/favicons/favicon.ico" />
4646

47-
<!-- js -->
48-
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>
49-
5047
<!-- jvectormap -->
5148
<link
5249
rel="stylesheet"
@@ -1051,6 +1048,8 @@ <h6 class="modal-title">All Applications</h6>
10511048

10521049
<!-- jquery -->
10531050
<script src="https://code.jquery.com/jquery-3.6.4.min.js"></script>
1051+
<!-- bootstrap.bundle.min.js -->
1052+
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>
10541053
<!-- chartjs -->
10551054
<script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
10561055
<!-- jvectormap -->

faq/index.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,6 @@
4444
<link rel="manifest" href="../static/img/favicons/site.webmanifest" />
4545
<link rel="icon" href="../static/img/favicons/favicon.ico" />
4646

47-
<!-- js -->
48-
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>
49-
5047
<!-- jvectormap -->
5148
<link
5249
rel="stylesheet"
@@ -1149,6 +1146,8 @@ <h6 class="modal-title">All Applications</h6>
11491146

11501147
<!-- jquery -->
11511148
<script src="https://code.jquery.com/jquery-3.6.4.min.js"></script>
1149+
<!-- bootstrap.bundle.min.js -->
1150+
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>
11521151
<!-- chartjs -->
11531152
<script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
11541153
<!-- jvectormap -->

index.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,6 @@
4444
<link rel="manifest" href="static/img/favicons/site.webmanifest" />
4545
<link rel="icon" href="static/img/favicons/favicon.ico" />
4646

47-
<!-- js -->
48-
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>
49-
5047
<!-- jvectormap -->
5148
<link
5249
rel="stylesheet"
@@ -1328,6 +1325,8 @@ <h6 class="modal-title">All Applications</h6>
13281325

13291326
<!-- jquery -->
13301327
<script src="https://code.jquery.com/jquery-3.6.4.min.js"></script>
1328+
<!-- bootstrap.bundle.min.js -->
1329+
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>
13311330
<!-- chartjs -->
13321331
<script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
13331332
<!-- jvectormap -->

mail/index.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,6 @@
4444
<link rel="manifest" href="../static/img/favicons/site.webmanifest" />
4545
<link rel="icon" href="../static/img/favicons/favicon.ico" />
4646

47-
<!-- js -->
48-
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>
49-
5047
<!-- jvectormap -->
5148
<link
5249
rel="stylesheet"
@@ -1343,6 +1340,8 @@ <h6 class="modal-title">All Applications</h6>
13431340

13441341
<!-- jquery -->
13451342
<script src="https://code.jquery.com/jquery-3.6.4.min.js"></script>
1343+
<!-- bootstrap.bundle.min.js -->
1344+
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>
13461345
<!-- chartjs -->
13471346
<script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
13481347
<!-- jvectormap -->

0 commit comments

Comments
 (0)