Merge pull request #62 from suryavaddiraju/dev

documentation
suryavaddiraju · Nov 6, 2024 · bff4510 · bff4510
2 parents 5f70e6b + e45fcad
commit bff4510
Show file tree

Hide file tree

Showing 33 changed files with 176 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -34,10 +34,6 @@ A package built on top of IRCTC Website APIs to book train tickets, managing use
 > ```
 
 
-## Useful Links
-
-<a href="https://github.com/suryavaddiraju/irctc-api"><img src="https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png" alt="GitHub Logo" width="50" height="50"/></a> <a href="https://www.npmjs.com/package/irctc-api"><img src="https://upload.wikimedia.org/wikipedia/commons/d/db/Npm-logo.svg" alt="npm Logo" width="50" height="50"/></a> <a href="https://dev.vaddiraju.in/irctc-api/api_reference"><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/d/d2/Read-the-docs.png/330px-Read-the-docs.png" alt="Documentation Logo" width="50" height="50"/></a>
-
 ## Installing
 
 To install the this package, simply type i or install irctc-api using the node package manager

diff --git a/docs/_includes/custom-head.html b/docs/_includes/custom-head.html
@@ -0,0 +1,6 @@
+{% comment %}
+  Placeholder to allow defining custom head, in principle, you can add anything here, e.g. favicons:
+
+  1. Head over to https://realfavicongenerator.net/ to add your own favicons.
+  2. Customize default _includes/custom-head.html in your source directory and insert the given code snippet.
+{% endcomment %}
diff --git a/docs/_includes/disqus_comments.html b/docs/_includes/disqus_comments.html
@@ -0,0 +1,20 @@
+{%- if page.comments != false and jekyll.environment == "production" -%}
+
+  <div id="disqus_thread"></div>
+  <script>
+    var disqus_config = function () {
+      this.page.url = '{{ absolute_url }}';
+      this.page.identifier = '{{ page.url | absolute_url }}';
+    };
+
+    (function() {
+      var d = document, s = d.createElement('script');
+
+      s.src = 'https://{{ site.disqus.shortname }}.disqus.com/embed.js';
+
+      s.setAttribute('data-timestamp', +new Date());
+      (d.head || d.body).appendChild(s);
+    })();
+  </script>
+  <noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript" rel="nofollow">comments powered by Disqus.</a></noscript>
+{%- endif -%}
diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html
@@ -0,0 +1,37 @@
+<footer class="site-footer h-card">
+  <data class="u-url" href="{{ "/" | relative_url }}"></data>
+
+  <div class="wrapper">
+
+    <div class="footer-col-wrapper">
+      <div class="footer-col">
+        <p class="feed-subscribe">
+          <a href="{{ site.feed.path | default: 'feed.xml' | absolute_url }}">
+            <svg class="svg-icon orange">
+              <use xlink:href="{{ 'assets/minima-social-icons.svg#rss' | relative_url }}"></use>
+            </svg><span>Subscribe</span>
+          </a>
+        </p>
+      {%- if site.author %}
+        <ul class="contact-list">
+          {% if site.author.name -%}
+            <li class="p-name">{{ site.author.name | escape }}</li>
+          {% endif -%}
+          {% if site.author.email -%}
+            <li><a class="u-email" href="mailto:{{ site.author.email }}">{{ site.author.email }}</a></li>
+          {%- endif %}
+        </ul>
+      {%- endif %}
+      </div>
+      <div class="footer-col">
+        <p>{{ site.description | escape }}</p>
+      </div>
+    </div>
+
+    <div class="social-links">
+      {%- include social.html -%}
+    </div>
+
+  </div>
+
+</footer>
diff --git a/docs/_includes/google-adsense.html b/docs/_includes/google-adsense.html
@@ -0,0 +1,2 @@
+<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-2262454035081166"
+     crossorigin="anonymous"></script>
diff --git a/docs/_includes/google-analytics.html b/docs/_includes/google-analytics.html
@@ -0,0 +1,9 @@
+<script async src="https://www.googletagmanager.com/gtag/js?id={{ site.google_analytics }}"></script>
+<script>
+  window['ga-disable-{{ site.google_analytics }}'] = window.doNotTrack === "1" || navigator.doNotTrack === "1" || navigator.doNotTrack === "yes" || navigator.msDoNotTrack === "1";
+  window.dataLayer = window.dataLayer || [];
+  function gtag(){window.dataLayer.push(arguments);}
+  gtag('js', new Date());
+
+  gtag('config', '{{ site.google_analytics }}');
+</script>
diff --git a/docs/_includes/head.html b/docs/_includes/head.html
@@ -0,0 +1,16 @@
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  {%- seo -%}
+  <link rel="stylesheet" href="{{ "/assets/css/style.css" | relative_url }}">
+  {%- feed_meta -%}
+  {%- if jekyll.environment == 'production' and site.google_analytics -%}
+    {%- include google-analytics.html -%}
+  {%- endif -%}
+  {%- if jekyll.environment == 'production' -%}
+    {%- include google-adsense.html -%}
+  {%- endif -%}
+  {%- include custom-head.html -%}
+
+</head>
diff --git a/docs/_includes/header.html b/docs/_includes/header.html
@@ -0,0 +1,31 @@
+<header class="site-header">
+
+  <div class="wrapper">
+    {%- assign default_paths = site.pages | map: "path" -%}
+    {%- assign page_paths = site.header_pages | default: default_paths -%}
+    {%- assign titles_size = site.pages | map: 'title' | join: '' | size -%}
+    <a class="site-title" rel="author" href="{{ "/" | relative_url }}">{{ site.title | escape }}</a>
+
+    {%- if titles_size > 0 -%}
+      <nav class="site-nav">
+        <input type="checkbox" id="nav-trigger" class="nav-trigger" />
+        <label for="nav-trigger">
+          <span class="menu-icon">
+            <svg viewBox="0 0 18 15" width="18px" height="15px">
+              <path d="M18,1.484c0,0.82-0.665,1.484-1.484,1.484H1.484C0.665,2.969,0,2.304,0,1.484l0,0C0,0.665,0.665,0,1.484,0 h15.032C17.335,0,18,0.665,18,1.484L18,1.484z M18,7.516C18,8.335,17.335,9,16.516,9H1.484C0.665,9,0,8.335,0,7.516l0,0 c0-0.82,0.665-1.484,1.484-1.484h15.032C17.335,6.031,18,6.696,18,7.516L18,7.516z M18,13.516C18,14.335,17.335,15,16.516,15H1.484 C0.665,15,0,14.335,0,13.516l0,0c0-0.82,0.665-1.483,1.484-1.483h15.032C17.335,12.031,18,12.695,18,13.516L18,13.516z"/>
+            </svg>
+          </span>
+        </label>
+
+        <div class="trigger">
+          {%- for path in page_paths -%}
+            {%- assign my_page = site.pages | where: "path", path | first -%}
+            {%- if my_page.title -%}
+            <a class="page-link" href="{{ my_page.url | relative_url }}">{{ my_page.title | escape }}</a>
+            {%- endif -%}
+          {%- endfor -%}
+        </div>
+      </nav>
+    {%- endif -%}
+  </div>
+</header>
diff --git a/docs/_includes/social-icons/bluesky.svg b/docs/_includes/social-icons/bluesky.svg
diff --git a/docs/_includes/social-icons/codeberg.svg b/docs/_includes/social-icons/codeberg.svg
diff --git a/docs/_includes/social-icons/devto.svg b/docs/_includes/social-icons/devto.svg
diff --git a/docs/_includes/social-icons/dribbble.svg b/docs/_includes/social-icons/dribbble.svg
diff --git a/docs/_includes/social-icons/facebook.svg b/docs/_includes/social-icons/facebook.svg
diff --git a/docs/_includes/social-icons/flickr.svg b/docs/_includes/social-icons/flickr.svg
diff --git a/docs/_includes/social-icons/github.svg b/docs/_includes/social-icons/github.svg
diff --git a/docs/_includes/social-icons/gitlab.svg b/docs/_includes/social-icons/gitlab.svg
diff --git a/docs/_includes/social-icons/google_scholar.svg b/docs/_includes/social-icons/google_scholar.svg
diff --git a/docs/_includes/social-icons/instagram.svg b/docs/_includes/social-icons/instagram.svg
diff --git a/docs/_includes/social-icons/keybase.svg b/docs/_includes/social-icons/keybase.svg
diff --git a/docs/_includes/social-icons/linkedin.svg b/docs/_includes/social-icons/linkedin.svg
diff --git a/docs/_includes/social-icons/mastodon.svg b/docs/_includes/social-icons/mastodon.svg
diff --git a/docs/_includes/social-icons/microdotblog.svg b/docs/_includes/social-icons/microdotblog.svg
diff --git a/docs/_includes/social-icons/pinterest.svg b/docs/_includes/social-icons/pinterest.svg
diff --git a/docs/_includes/social-icons/rss.svg b/docs/_includes/social-icons/rss.svg
diff --git a/docs/_includes/social-icons/stackoverflow.svg b/docs/_includes/social-icons/stackoverflow.svg
diff --git a/docs/_includes/social-icons/telegram.svg b/docs/_includes/social-icons/telegram.svg