From 24b78de5aac1f89a4cce837a12f9d08e1a1c9ca2 Mon Sep 17 00:00:00 2001 From: Manuel Date: Sun, 7 Jan 2024 13:18:37 +0100 Subject: [PATCH] Use dark theme for jekyll --- docs/_config.yml | 5 +-- docs/_sass/color_schemes/iotic.scss | 7 ++++ docs/about.markdown | 10 ----- ...onfiguration.markdown => configuration.md} | 2 +- docs/index.md | 38 ++++--------------- ...{installation.markdown => installation.md} | 2 +- ...{key_concepts.markdown => key_concepts.md} | 2 +- 7 files changed, 18 insertions(+), 48 deletions(-) create mode 100644 docs/_sass/color_schemes/iotic.scss delete mode 100644 docs/about.markdown rename docs/{configuration.markdown => configuration.md} (70%) rename docs/{installation.markdown => installation.md} (70%) rename docs/{key_concepts.markdown => key_concepts.md} (70%) diff --git a/docs/_config.yml b/docs/_config.yml index 312e1e8..63324a0 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -3,9 +3,6 @@ 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 diff --git a/docs/_sass/color_schemes/iotic.scss b/docs/_sass/color_schemes/iotic.scss new file mode 100644 index 0000000..1d46051 --- /dev/null +++ b/docs/_sass/color_schemes/iotic.scss @@ -0,0 +1,7 @@ +@import "./color_schemes/dark"; + +//$link-color: #f5ba44; +$btn-primary-color: #f5ba44; // +//$body-heading-color: #f5ba44; +$body-background-color: #f5ba44; +$background-color: #000000; diff --git a/docs/about.markdown b/docs/about.markdown deleted file mode 100644 index df2aaf9..0000000 --- a/docs/about.markdown +++ /dev/null @@ -1,10 +0,0 @@ ---- -layout: page -title: About ---- - -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/configuration.markdown b/docs/configuration.md similarity index 70% rename from docs/configuration.markdown rename to docs/configuration.md index e3590eb..b6ead9b 100644 --- a/docs/configuration.markdown +++ b/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 index ca0c545..1a45d2a 100644 --- 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 b/docs/installation.md similarity index 70% rename from docs/installation.markdown rename to docs/installation.md index e9c0c24..917e2b5 100644 --- a/docs/installation.markdown +++ b/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.md similarity index 70% rename from docs/key_concepts.markdown rename to docs/key_concepts.md index 7aa9ae8..e2c4127 100644 --- a/docs/key_concepts.markdown +++ b/docs/key_concepts.md @@ -1,5 +1,5 @@ --- layout: page title: Key Concepts -id: key_concepts +nav_order: 20 ---