feat(docs): migrate documentation site into monorepo (#5912)
This commit is contained in:
1 parent
3e464a76f2
commit
9e421c67bd
605 files changed
+26764
-219
No files matched your search
Binary file not shown.
|
After Width: | Height: | Size: 6.2 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 8.1 KiB |
@@ -0,0 +1,40 @@
|
||||
---
|
||||
title: 'Weather'
|
||||
description: 'Displays the current weather information of a set location.'
|
||||
hide_title: true
|
||||
---
|
||||
|
||||
import { AddingWidget } from '@site/src/components/widgets/adding';
|
||||
import { WidgetConfig } from '@site/src/components/widgets/configuration';
|
||||
import { WidgetHeader } from '@site/src/components/widgets/header';
|
||||
import { weatherWidget } from '.';
|
||||
|
||||
|
||||
<WidgetHeader
|
||||
widget={weatherWidget}
|
||||
categories={["Weather"]}
|
||||
/>
|
||||
|
||||
The Weather Widget uses your location to display the current, highest and lowest temperature.
|
||||
|
||||
### Screenshots
|
||||
|
||||
import forecastWeather from './img/forecast.png';
|
||||
import currentWeather from './img/current.png';
|
||||
|
||||
<div className="flex flex-col gap-1">
|
||||
<img src={forecastWeather} alt="weather forecast-5-days" width={128 * 4.5} />
|
||||
<img src={currentWeather} alt="weather current" width={128 * 3} />
|
||||
</div>
|
||||
|
||||
### Adding the widget
|
||||
|
||||
<AddingWidget />
|
||||
|
||||
### Configuration
|
||||
<WidgetConfig configuration={weatherWidget.configuration} />
|
||||
|
||||
### Data source
|
||||
|
||||
We use the Open Meteo API to fetch the weather and locations.
|
||||
If you need to whitelist the api, please use the following URL: `https://open-meteo.com`
|
||||
@@ -0,0 +1,80 @@
|
||||
import { WidgetDefinition } from "@site/src/types";
|
||||
import { IconCloud } from "@tabler/icons-react";
|
||||
|
||||
export const weatherWidget: WidgetDefinition = {
|
||||
icon: IconCloud,
|
||||
name: "Weather",
|
||||
description: "Displays the current weather information of a set location.",
|
||||
path: "../../widgets/weather",
|
||||
configuration: {
|
||||
items: [
|
||||
{
|
||||
name: "Temperature in Fahrenheit",
|
||||
description: "Display temperature in Fahrenheit instead of Celsius",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "no",
|
||||
},
|
||||
{
|
||||
name: "Disable temperature decimals",
|
||||
description: "Show temperature as full number",
|
||||
values: {
|
||||
type: "boolean",
|
||||
},
|
||||
defaultValue: "no",
|
||||
},
|
||||
{
|
||||
name: "Show current wind speed",
|
||||
description: "Display current wind speed, only for current weather",
|
||||
values: {
|
||||
type: "boolean",
|
||||
},
|
||||
defaultValue: "yes",
|
||||
},
|
||||
{
|
||||
name: "Use imperial speed units",
|
||||
description: "Display wind speed in mph instead of km/h",
|
||||
values: {
|
||||
type: "boolean",
|
||||
},
|
||||
defaultValue: "no",
|
||||
},
|
||||
{
|
||||
name: "Weather location",
|
||||
description: "Location for which to display the weather information",
|
||||
values: "Select location through search or longitude/latitude",
|
||||
defaultValue: "Paris / 48.85341, 2.3488",
|
||||
},
|
||||
{
|
||||
name: "Date format",
|
||||
description: "Format for displaying the date in the widget",
|
||||
values: {
|
||||
type: "select",
|
||||
options: ["dddd, MMMM D", "dddd, D MMMM", "MMM D", "D MMM", "DD/MM/YYYY", "MM/DD/YYYY", "DD/MM", "MM/DD"],
|
||||
},
|
||||
defaultValue: "dddd, MMMM D",
|
||||
},
|
||||
{
|
||||
name: "Show city",
|
||||
description: "Display the city name in the widget",
|
||||
values: {
|
||||
type: "boolean",
|
||||
},
|
||||
defaultValue: "no",
|
||||
},
|
||||
{
|
||||
name: "Has forecast",
|
||||
description: "Display a forecast for the next few days",
|
||||
values: {
|
||||
type: "boolean",
|
||||
},
|
||||
defaultValue: "no",
|
||||
},
|
||||
{
|
||||
name: "Amount of forecast days",
|
||||
description: "Number of days to show in the forecast",
|
||||
values: "1-7",
|
||||
defaultValue: "5",
|
||||
},
|
||||
],
|
||||
},
|
||||
};
|
||||
Reference in new issue
Block a user