Wiki completed

Co-authored-by: Kelvin Natal <[email protected]> Co-authored-by: Ronilsonb2 <[email protected]> Co-authored-by: oFrancoGui <[email protected]>
bigois · Jul 4, 2023 · 1ad98f3 · 1ad98f3
1 parent 7db9d85
commit 1ad98f3
Show file tree

Hide file tree

Showing 12 changed files with 14,453 additions and 110 deletions.
diff --git a/_config.yml b/_config.yml
@@ -112,16 +112,10 @@ aux_links_new_tab: false
 # nav_sort: case_insensitive # default, equivalent to nil
 nav_sort: case_sensitive # Capital letters sorted before lowercase
 
-# External navigation links
-nav_external_links:
-  - title: KIRGH Energy on GitHub
-    url: https://github.com/bigois/kirgh-energy
-
 # Back to top link
 back_to_top: true
 back_to_top_text: "Back to top"
 
-
 # Footer content and last edited timestamp
 footer_content: "Copyright &copy; 2023-2023 KIRGH Energy. Distributed by an <a href=\"https://github.com/bigois/kirgh-energy/blob/main/LICENSE\">MIT license.</a>"
 last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
@@ -135,7 +129,7 @@ gh_edit_branch: "main" # the branch that your docs is served from
 gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
 
 # Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define
-color_scheme: nil
+color_scheme: dark
 
 callouts_level: quiet # or loud
 callouts:

diff --git a/_includes/components/aux_nav.html b/_includes/components/aux_nav.html
@@ -0,0 +1,37 @@
+<nav aria-label="Auxiliary" class="aux-nav">
+  <svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
+    <symbol id="svg-sun" viewBox="0 0 24 24">
+      <title>Light mode</title>
+      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
+        stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
+        <circle cx="12" cy="12" r="5"></circle>
+        <line x1="12" y1="1" x2="12" y2="3"></line>
+        <line x1="12" y1="21" x2="12" y2="23"></line>
+        <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
+        <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
+        <line x1="1" y1="12" x2="3" y2="12"></line>
+        <line x1="21" y1="12" x2="23" y2="12"></line>
+        <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
+        <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
+      </svg>
+    </symbol>
+    <symbol id="svg-moon" viewBox="0 0 24 24">
+      <title>Dark mode</title>
+      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
+        stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
+        <path stroke="none" d="M0 0h24v24H0z" fill="none" />
+        <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
+      </svg>
+    </symbol>
+  </svg>
+  <ul class="aux-nav-list">
+    <li class="aux-nav-list-item">
+      <a id="theme-toggle" class="site-button"><svg width='18px' height='18px'><use href="#svg-sun"></use></svg></a>
+    </li>
+    <li class="aux-nav-list-item">
+      <a href="https://github.com/bigois/kirgh-energy" class="site-button" target="_blank" rel="noopener noreferrer">
+        KIRGH Energy on GitHub
+      </a>
+    </li>
+  </ul>
+</nav>
diff --git a/_includes/head.html b/_includes/head.html
@@ -0,0 +1,44 @@
+<head>
+  <meta charset="UTF-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=Edge">
+
+  <script>
+    if (localStorage.getItem('theme') === 'dark') document.documentElement.classList.add('dark-mode');
+  </script>
+  <script type="text/javascript" src="{{ '/assets/js/theme-switch.js' | relative_url }}" defer></script>
+  <link rel="stylesheet" href="{{ '/assets/css/just-the-docs-switchable.css' | relative_url }}">
+
+  {% if site.ga_tracking != nil %}
+    {% assign ga_tracking_ids = site.ga_tracking | split: "," %}
+    <script async src="https://www.googletagmanager.com/gtag/js?id={{ ga_tracking_ids.first }}"></script>
+    <script>
+      window.dataLayer = window.dataLayer || [];
+      function gtag(){dataLayer.push(arguments);}
+      gtag('js', new Date());
+
+      {% for ga_property in ga_tracking_ids %}
+        gtag('config', '{{ ga_property }}'{% unless site.ga_tracking_anonymize_ip == nil %}, { 'anonymize_ip': true }{% endunless %});
+      {% endfor %}
+    </script>
+  {% endif %}
+
+  {% if site.search_enabled != false %}
+    <script src="{{ '/assets/js/vendor/lunr.min.js' | relative_url }}"></script>
+  {% endif %}
+
+  <script src="{{ '/assets/js/just-the-docs.js' | relative_url }}"></script>
+
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+
+  {% for file in site.static_files %}
+    {% if file.path == site.favicon_ico or file.path == '/favicon.ico' %}
+      {% assign favicon = true %}
+    {% endif %}
+  {% endfor %}
+  {% if favicon %}
+    <link rel="icon" href="{{ site.favicon_ico | default: '/favicon.ico' | relative_url }}" type="image/x-icon">
+  {% endif %}
+
+  {% seo %}
+
+</head>
diff --git a/_includes/title.html b/_includes/title.html
@@ -0,0 +1,3 @@
+<img src="https://github.com/bigois/kirgh-energy/blob/main/docs/images/logo-kirgh.png?raw=true" width="48">
+<pre> </pre>
+KIRGH Energy
diff --git a/_sass/custom/custom.scss b/_sass/custom/custom.scss
@@ -0,0 +1,33 @@
+// Print-only styles.
+@media print {
+  .side-bar,
+  .page-header {
+    display: none;
+  }
+  .main-content {
+    max-width: auto;
+    margin: 1em;
+  }
+}
+
+// Code block style.
+.highlight {
+  .n {
+    color: #525151;
+  }
+  .o {
+    color: #660707;
+  }
+  .nl {
+    color: darkgreen;
+  }
+  .kt {
+    color: darkblue;
+  }
+  .fm {
+    color: blue;
+  }
+  .sb {
+    color: darkcyan;
+  }
+}
diff --git a/_sass/custom/setup.scss b/_sass/custom/setup.scss
@@ -0,0 +1,8 @@
+$pink-000: #f77ef1;
+$pink-100: #f967f1;
+$pink-200: #e94ee1;
+$pink-300: #dd2cd4;
+
+pre.highlight {
+  line-height: 1;
+}