Use dark theme for jekyll

mincequi · Jan 7, 2024 · 067c8f0 · 067c8f0
1 parent 2d580f5
commit 067c8f0
Show file tree

Hide file tree

Showing 9 changed files with 81 additions and 53 deletions.
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
@@ -11,8 +11,7 @@ GEM
     eventmachine (1.2.7)
     ffi (1.16.3)
     forwardable-extended (2.6.0)
-    google-protobuf (3.25.1-arm64-darwin)
-    google-protobuf (3.25.1-x86_64-linux)
+    google-protobuf (3.25.1)
     http_parser.rb (0.8.0)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
@@ -74,6 +73,7 @@ GEM
     webrick (1.8.1)
 
 PLATFORMS
+  arm64-darwin-22
   arm64-darwin-23
   x86_64-linux
 

diff --git a/docs/_config.yml b/docs/_config.yml
@@ -3,9 +3,10 @@ email: mincequi@web.de
 description: Iotic streamlines the management of extra solar energy, making it easy to direct and optimize.
 github_username: mincequi
 theme: just-the-docs
-
 url: https://mincequi.github.io/iotic
 
-# aux_links:
-#  Template Repository: https://github.com/just-the-docs/just-the-docs-template
+color_scheme: iotic
 
+aux_links:
+  "Iotic on GitHub":
+    - "//github.com/mincequi/iotic"
diff --git a/docs/_sass/color_schemes/iotic.scss b/docs/_sass/color_schemes/iotic.scss
@@ -0,0 +1,9 @@
+@import "./color_schemes/dark";
+
+$link-color: #000000;
+$feedback-color: #f5ba44;
+$sidebar-color: darken($feedback-color, 17%);
+//$btn-primary-color: #f5ba44;
+//$body-heading-color: #000000; // This changes the title color
+//$body-background-color: #f5ba44;
+//$background-color: #000000;
diff --git a/docs/about.markdown b/docs/about.markdown
diff --git a/docs/configuration.markdown → docs/configuration.md b/docs/configuration.markdown → docs/configuration.md
@@ -1,5 +1,5 @@
 ---
 layout: page
 title: Configuration
-id: configuration
+nav_order: 40
 ---
diff --git a/docs/index.md b/docs/index.md
@@ -1,35 +1,11 @@
 ---
-title: Home
+title: About
 layout: home
+nav_order: 10
 ---
 
-This is a *bare-minimum* template to create a Jekyll site that uses the [Just the Docs] theme. You can easily set the created site to be published on [GitHub Pages] – the [README] file explains how to do that, along with other details.
-
-If [Jekyll] is installed on your computer, you can also build and preview the created site *locally*. This lets you test changes before committing them, and avoids waiting for GitHub Pages.[^1] And you will be able to deploy your local build to a different platform than GitHub Pages.
-
-More specifically, the created site:
-
-- uses a gem-based approach, i.e. uses a `Gemfile` and loads the `just-the-docs` gem
-- uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages
-
-Other than that, you're free to customize sites that you create with this template, however you like. You can easily change the versions of `just-the-docs` and Jekyll it uses, as well as adding further plugins.
-
-[Browse our documentation][Just the Docs] to learn more about how to use this theme.
-
-To get started with creating a site, simply:
-
-1. click "[use this template]" to create a GitHub repository
-2. go to Settings > Pages > Build and deployment > Source, and select GitHub Actions
-
-If you want to maintain your docs in the `docs` directory of an existing project repo, see [Hosting your docs from an existing project repo](https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md#hosting-your-docs-from-an-existing-project-repo) in the template README.
-
-----
-
-[^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site).
-
-[Just the Docs]: https://just-the-docs.github.io/just-the-docs/
-[GitHub Pages]: https://docs.github.com/en/pages
-[README]: https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md
-[Jekyll]: https://jekyllrb.com
-[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/
-[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate
+Iotic is an easy-to-use software tool that optimizes surplus solar energy from PV systems,
+effortlessly directing excess power to applications like heating rods, electric cars, and
+heat pumps. With a user-friendly interface, Iotic is suitable for various PV installations,
+offering practical energy management to reduce costs and promote sustainability with simplicity
+in mind.
diff --git a/docs/installation.markdown → docs/installation.md b/docs/installation.markdown → docs/installation.md
@@ -1,5 +1,5 @@
 ---
 layout: page
 title: Installation
-id: installation
+nav_order: 30
 ---
diff --git a/docs/key_concepts.markdown b/docs/key_concepts.markdown
diff --git a/docs/key_concepts.md b/docs/key_concepts.md
@@ -0,0 +1,57 @@
+---
+layout: page
+title: Key Concepts
+nav_order: 20
+---
+
+## Discovery
+
+Automatic device discovery in the context of IoT (Internet of Things)
+streamlines the process by which IoT devices seamlessly join a management system
+(like Iotic) without manual intervention.
+This system ensures easy detection of devices and device changes
+and contributes to the overall efficiency and reliability. With plug-and-play
+functionality and centralized monitoring, automatic device
+discovery simplifies the integration and management of devices within the Iotic
+ecosystem. Iotic dynamically identifies and updates
+its inventory in real-time.
+
+### Modbus Discovery
+
+Iotic has a built-in modbus device discovery. This process involves a focused
+port scan within the same IPv4 subnet of an Iotic instance by probing devices
+for open port 502, commonly associated with Modbus communication.
+
+### SunSpec Discovery
+
+SunSpec discovery builds upon Modbus discovery by specifically targeting SunSpec
+information models within the Modbus protocol. By honing in on SunSpec data
+structures, Iotic identifies and integrates devices adhering to SunSpec
+standards for renewable energy, offering a more nuanced and comprehensive
+approach to recognition and integration within the Iotic ecosystem.
+
+### HTTP Discovery
+
+This discovery automates the identification and accessibility of HTTP-based
+services within a network, considering that certain IoT devices, including
+go-eChargers, utilize this protocol. This method allows devices hosting such
+services to broadcast their presence.
+
+## Things
+
+In the context of the Internet of Things (IoT), everyday objects and devices are
+interconnected, enabling them to communicate and share data over a network. This
+connectivity allows for seamless integration and automation, enhancing
+efficiency and convenience in various aspects of life. From smart homes with
+connected thermostats and applications like optimizing energy production and
+monitoring performance in photovoltaic systems, the IoT revolutionizes how we
+interact with and manage the physical world through the power of interconnected
+technology.
+
+## Properties
+
+In the context of an IoT device or thing, "properties" refer to the
+characteristics, attributes, or data points associated with that device.
+Properties provide information about the state, behavior, or configuration of an
+IoT device, allowing users and other systems to interact with and monitor the
+device effectively.