Skip to content

Commit

Permalink
Use dark theme for jekyll
Browse files Browse the repository at this point in the history
  • Loading branch information
mincequi committed Jan 7, 2024
1 parent 2d580f5 commit 7f884f0
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 48 deletions.
5 changes: 1 addition & 4 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
5 changes: 5 additions & 0 deletions docs/_sass/color_schemes/iotic.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
@import "./color_schemes/dark";

//$link-color: #f5ba44;
$btn-primary-color: #f5ba44;
$body-heading-color: #f5ba44;
10 changes: 0 additions & 10 deletions docs/about.markdown

This file was deleted.

2 changes: 1 addition & 1 deletion docs/configuration.markdown → docs/configuration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
layout: page
title: Configuration
id: configuration
nav_order: 40
---
38 changes: 7 additions & 31 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion docs/installation.markdown → docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
layout: page
title: Installation
id: installation
nav_order: 30
---
2 changes: 1 addition & 1 deletion docs/key_concepts.markdown → docs/key_concepts.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
layout: page
title: Key Concepts
id: key_concepts
nav_order: 20
---

0 comments on commit 7f884f0

Please sign in to comment.