Skip to content

Commit

Permalink
documentation page added.
Browse files Browse the repository at this point in the history
  • Loading branch information
@asis2016
asis2016 committed Jan 11, 2024
1 parent 67d546c commit 0ff4a22
Show file tree
Hide file tree
Showing 13 changed files with 251 additions and 53 deletions.
5 changes: 2 additions & 3 deletions 404/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,6 @@
<link rel="manifest" href="../static/img/favicons/site.webmanifest" />
<link rel="icon" href="../static/img/favicons/favicon.ico" />

<!-- js -->
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>

<!-- jvectormap -->
<link
rel="stylesheet"
Expand Down Expand Up @@ -846,6 +843,8 @@ <h6 class="modal-title">All Applications</h6>

<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.6.4.min.js"></script>
<!-- bootstrap.bundle.min.js -->
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>
<!-- chartjs -->
<script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
<!-- jvectormap -->
Expand Down
5 changes: 2 additions & 3 deletions blank-page/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,6 @@
<link rel="manifest" href="../static/img/favicons/site.webmanifest" />
<link rel="icon" href="../static/img/favicons/favicon.ico" />

<!-- js -->
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>

<!-- jvectormap -->
<link
rel="stylesheet"
Expand Down Expand Up @@ -846,6 +843,8 @@ <h6 class="modal-title">All Applications</h6>

<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.6.4.min.js"></script>
<!-- bootstrap.bundle.min.js -->
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>
<!-- chartjs -->
<script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
<!-- jvectormap -->
Expand Down
233 changes: 227 additions & 6 deletions documentation/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

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

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

<!-- CSS -->
Expand Down Expand Up @@ -44,9 +44,6 @@
<link rel="manifest" href="../static/img/favicons/site.webmanifest" />
<link rel="icon" href="../static/img/favicons/favicon.ico" />

<!-- js -->
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>

<!-- jvectormap -->
<link
rel="stylesheet"
Expand Down Expand Up @@ -425,8 +422,230 @@ <h3 class="md-mb-0">Documentation</h3>
<!-- page title ends -->

<div class="row mt-4">
<div class="col">
<h1>Django Dark Admin Template</h1>
<div class="col-lg-12">
<!-- about -->
<section class="my-4">
<p>
This project titled as adminAM is an open source admin
template created by
<a
href="http://127.0.0.1:9002/documentation/www.amaharjan.de"
target="_blank"
class="link-offset-2"
>www.amaharjan.de</a
>
🔗.
</p>
</section>
<div class="divider"></div>
<!-- about ends -->

<!-- quick start -->
<section class="my-4">
<h3>Quick Start</h3>
<p>Jump-start your project with adminAM:</p>
<pre>
<code>
$ mkdir your_project_name
$ cd your_project_name
$ git clone https://github.com/asis2016/bootstrap-5-admin-template.git
</code>
</pre>
</section>
<div class="divider"></div>
<!-- quick start ends -->

<!-- Dependencies & Plugins -->
<section class="my-4">
<h3>Dependencies & Plugins</h3>
<p>
The adminAM depends on the following frameworks and plugins:
</p>
<ul>
<li>
<a
href="https://getbootstrap.com/"
target="_blank"
class="link-offset-2 amj-a"
>
<i class="bi bi-bootstrap me-2"></i> Bootstrap v5.3.2
</a>
</li>
<!-- jQuery -->
<li>
<a
href="index.html#"
target="_blank"
class="link-offset-2 amj-a"
>
<i class="bi bi-filetype-js me-2"></i> jQuery v3.6.4
</a>
</li>
<!-- chart.js -->
<li>
<a
href="https://www.chartjs.org/"
target="_blank"
class="link-offset-2 amj-a"
>
<i class="bi bi-graph-up-arrow me-2"></i> Chart.js v4.4.1
</a>
</li>
<!-- jVectorMap -->
<li>
<a
href="https://jvectormap.com/"
target="_blank"
class="link-offset-2 amj-a"
>
<i class="bi bi-graph-up-arrow me-2"></i> jVectorMap
v2.0.5
</a>
</li>
<!-- plotly -->
<li>
<a
href="https://plotly.com/javascript/"
target="_blank"
class="link-offset-2 amj-a"
>
<i class="bi bi-graph-up-arrow me-2"></i> plotly.js
v1.58.5
</a>
</li>
<!-- Bootstrap Icons v1.11.2 -->
<li>
<a
href="https://icons.getbootstrap.com/"
target="_blank"
class="link-offset-2 amj-a"
>
<i class="bi bi-bootstrap me-2"></i> Bootstrap Icons
v1.11.2
</a>
</li>
<!-- Google fonts -->
<li>
<a
href="https://fonts.google.com/"
target="_blank"
class="link-offset-2 amj-a"
>
<i class="bi bi-fonts me-2"></i> Google Fonts
</a>
</li>
</ul>
</section>
<div class="divider"></div>
<!-- Dependencies & Plugins ends -->

<!-- features/pages -->
<section class="my-4">
<h3>Features / Pages</h3>
<ol>
<li>404 page</li>
<li>Account login page</li>
<li>Account registration page</li>
<li>Blank page</li>
<li>Dashboard page</li>
<li>Mail page</li>
<li>Product page</li>
<ul>
<li>Product list page</li>
<li>Expenses report page</li>
<li>Sales report page</li>
</ul>
<li>Profile page</li>
<li>Search results page</li>
<li>Single page</li>
</ol>
</section>
<div class="divider"></div>
<!-- features/pages ends -->

<!-- license -->
<section class="my-4">
<h3>License</h3>
<p>
<b><i>adminAM - Bootstrap 5 admin template</i></b> is free!
And always remain free. The project is licensed under MIT,
that means:
</p>
<p>Copyright (c) 2024 Ashish S. Maharjan</p>
<p>
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
</p>
<p>
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the
Software.
</p>
<p>
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
</p>
</section>
<div class="divider"></div>
<!-- license ends -->

<!-- bugs and issues -->
<section class="my-4">
<h3>Bugs and Issues</h3>
<p>
Have a bug or an issue with this template? Please
<a
href="https://github.com/asis2016/bootstrap-5-admin-template/issues"
target="_blank"
class="link-offset-2"
>
Open a new issue
</a>
🔗 on GitHub.
</p>
</section>
<div class="divider"></div>
<!-- bugs and issues ends -->

<!-- contribution -->
<section class="my-4">
<h3>Contributing & Feedback</h3>
<p>
Contributions are always welcome! And, if you have any
feedback or query, please reach out to me at
<a href="mailto:hello@amaharjan.de">hello@amaharjan.de</a>.
</p>
</section>
<div class="divider"></div>
<!-- contribution ends-->

<!-- Buy me a coffee -->
<section class="my-4">
<h3>Buy me a coffee</h3>
<p>
Your gracious contribution through
<a
href="https://www.paypal.com/paypalme/asis2016"
target="_blank"
class="link-offset-2"
>PayPal</a
>
🔗 would very much support the development of this project.
</p>
</section>
<!-- Buy me a coffee ends -->
</div>
</div>

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

<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.6.4.min.js"></script>
<!-- bootstrap.bundle.min.js -->
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>
<!-- chartjs -->
<script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
<!-- jvectormap -->
Expand Down
5 changes: 2 additions & 3 deletions expenses/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,6 @@
<link rel="manifest" href="../static/img/favicons/site.webmanifest" />
<link rel="icon" href="../static/img/favicons/favicon.ico" />

<!-- js -->
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>

<!-- jvectormap -->
<link
rel="stylesheet"
Expand Down Expand Up @@ -1051,6 +1048,8 @@ <h6 class="modal-title">All Applications</h6>

<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.6.4.min.js"></script>
<!-- bootstrap.bundle.min.js -->
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>
<!-- chartjs -->
<script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
<!-- jvectormap -->
Expand Down
5 changes: 2 additions & 3 deletions faq/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,6 @@
<link rel="manifest" href="../static/img/favicons/site.webmanifest" />
<link rel="icon" href="../static/img/favicons/favicon.ico" />

<!-- js -->
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>

<!-- jvectormap -->
<link
rel="stylesheet"
Expand Down Expand Up @@ -1149,6 +1146,8 @@ <h6 class="modal-title">All Applications</h6>

<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.6.4.min.js"></script>
<!-- bootstrap.bundle.min.js -->
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>
<!-- chartjs -->
<script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
<!-- jvectormap -->
Expand Down
5 changes: 2 additions & 3 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,6 @@
<link rel="manifest" href="static/img/favicons/site.webmanifest" />
<link rel="icon" href="static/img/favicons/favicon.ico" />

<!-- js -->
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>

<!-- jvectormap -->
<link
rel="stylesheet"
Expand Down Expand Up @@ -1328,6 +1325,8 @@ <h6 class="modal-title">All Applications</h6>

<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.6.4.min.js"></script>
<!-- bootstrap.bundle.min.js -->
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>
<!-- chartjs -->
<script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
<!-- jvectormap -->
Expand Down
5 changes: 2 additions & 3 deletions mail/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,6 @@
<link rel="manifest" href="../static/img/favicons/site.webmanifest" />
<link rel="icon" href="../static/img/favicons/favicon.ico" />

<!-- js -->
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>

<!-- jvectormap -->
<link
rel="stylesheet"
Expand Down Expand Up @@ -1343,6 +1340,8 @@ <h6 class="modal-title">All Applications</h6>

<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.6.4.min.js"></script>
<!-- bootstrap.bundle.min.js -->
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>
<!-- chartjs -->
<script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
<!-- jvectormap -->
Expand Down
Loading

0 comments on commit 0ff4a22

Please sign in to comment.