Skip to content

Commit 179bcc0

Browse files
authored
Merge pull request #367 from khassel/develop
weather: add themes example
2 parents 34f7962 + 6d8f81d commit 179bcc0

1 file changed

Lines changed: 17 additions & 1 deletion

File tree

modules/weather.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,18 @@ To use this module, add it to the modules array in the `config/config.js` file:
3737
Beginning with MagicMirror² `v2.35.0` we offer the use of themes. With this enhancement
3838
users must not create an own module if they only want to change the design of the module.
3939

40-
Usage:
40+
### Motivation
41+
42+
The number of weather modules is probably the highest in the MagicMirror² universe.
43+
44+
For most, the focus is likely less on integrating a missing weather provider and more on the design.
45+
46+
Weather Themes are designed to fill this gap.
47+
48+
Simply rely on the existing weather module, which robustly takes care of retrieving the data,
49+
and just focus on customizing the design.
50+
51+
### Usage:
4152

4253
- create a theme directory under `modules`, e.g. `modules/myweathertemplate`.
4354
- create own files `current.njk`, `forecast.njk`, `hourly.njk` and `weather.css` in the new directory.
@@ -51,6 +62,11 @@ For advanced users there are more options to customize the template:
5162
- you can use custom scripts located in your theme directory which contain e.g. the 2 methods
5263
mentioned above or other stuff. Use the configuration option `themeCustomScripts` to load these scripts.
5364

65+
### Example
66+
67+
[MMT-WeatherSkycons](https://gitlab.com/khassel/MMT-WeatherSkycons) is probably the first weather theme for MagicMirror².
68+
It serves here as an example project to demonstrate the possibilities of the themes.
69+
5470
## Configuration options
5571

5672
The following properties can be configured:

0 commit comments

Comments
 (0)