Skip to content

Commit 7717ed9

Browse files
Fix markdownlint / spelling issues #3 (#19961)
1 parent 910cc1b commit 7717ed9

15 files changed

+99
-86
lines changed

source/_integrations/broadlink.markdown

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The Broadlink integration allows you to control and monitor Broadlink universal
2929

3030
{% include integrations/config_flow.md %}
3131

32-
### Entities and subdomains
32+
## Entities and subdomains
3333

3434
There is no more need to set up platforms, except for custom IR/RF switches. Once the device is configured, all entities will be created automatically.
3535

@@ -49,7 +49,6 @@ The `remote` entities allow you to learn and send codes with universal remotes.
4949

5050
Use `remote.learn_command` to learn IR and RF codes. These codes are grouped by device and stored as commands in the [storage folder](#Learned%20codes%20storage%20location). They can be sent with the `remote.send_command` service later.
5151

52-
5352
| Service data attribute | Optional | Description |
5453
| ---------------------- | -------- | ------------------------------------- |
5554
| `entity_id` | no | ID of the remote. |

source/_integrations/brottsplatskartan.markdown

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ longitude:
4343
default: Your home zone longitude defined in your configuration.
4444
{% endconfiguration %}
4545
46-
4746
## Notes
4847
4948
### Area

source/_integrations/browser.markdown

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,16 @@ To load this component, add the following lines to your `configuration.yaml`:
2020
browser:
2121
```
2222
23-
#### Service `browser/browse_url`
23+
### Services
24+
25+
Once loaded, the `browser` platform will expose services that can be called to perform various actions.
26+
27+
Available services: `browser/browse_url`.
2428

2529
| Service data attribute | Optional | Description |
2630
| ---------------------- | -------- | ----------- |
2731
| `url` | no | The URL to open.
2832

29-
3033
### Usage
3134

3235
To use this service, choose **Call Service** from the **Developer Tools**. Choose the service *browser/browse_url* from the list of **Available services:** and enter the URL into the **Service Data** field and hit **CALL SERVICE**.

source/_integrations/buienradar.markdown

Lines changed: 47 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -44,47 +44,47 @@ The Buienradar integration will set up separate sensor entities with more detail
4444

4545
The following entities will be created:
4646

47-
- **Station name**: The name of the selected meteo-station.
48-
- **Barometer forecast**: A numeric barametric forecast (1 to 7)
49-
- **Barometer forecast name**: "A textual representation of the barometer forecast (eg: Thunderstorms, Stable, etc.)."
50-
- **Condition code**: "A symbol and a unique code identifying the current weather condition ([a..z])."
51-
- **Condition**: A symbol and the current weather condition (`clear`, `cloudy`, `fog`, `rainy`, `snowy` or `lightning`).
52-
- **Condition detailed**: A symbol and detailed current weather condition (`clear`, `partlycloudy`, `cloudy`, `partlycloudy-fog`, `partlycloudy-light-rain`, `partlycloudy-rain`, `light-rain`, `rainy`, `snowy-rainy`, `partlycloudy-light-snow`, `partlycloudy-snow`, `light-snow`, `snowy`, `partlycloudy-lightning` or `lightning`).
53-
- **Condition exact**: A symbol with the full current weather condition (in English).
54-
- **Symbol**: A symbol for the current weather with the full current condition (in Dutch).
55-
- **Feel temperature**: "The current feel temperature (in [C](https://en.wikipedia.org/wiki/Celsius))."
56-
- **Humidity**: The relative humidity (%).
57-
- **Temperature**: "The current temperature (in [C](https://en.wikipedia.org/wiki/Celsius))."
58-
- **Ground temperature**: "The current ground temperature (in [C](https://en.wikipedia.org/wiki/Celsius))."
59-
- **Wind speed**: "The wind speed in [km/h](https://en.wikipedia.org/wiki/Kilometres_per_hour)."
60-
- **Wind force**: "The wind speed/force in [Bft](https://en.wikipedia.org/wiki/Beaufort_scale)."
61-
- **Wind direction**: "Where the wind is coming from: N (North), Z (south), NO (North-East), etc."
62-
- **Wind azimuth**: Where the wind is coming from in degrees, with true north at 0° and progressing clockwise.
63-
- **Pressure**: "The sea-level air pressure in [hPa](https://en.wikipedia.org/wiki/Hectopascal)."
64-
- **Visibility**: "Visibility in meters ([m](https://en.wikipedia.org/wiki/Metre))."
65-
- **Wind gust**: "The wind speed of wind gusts ([km/h](https://en.wikipedia.org/wiki/Kilometres_per_hour))."
66-
- **Precipation**: The amount of precipitation/rain in mm/h.
67-
- **Precipation forecast average**: The average expected precipitation/rain in mm/h within the given time-frame.
68-
- **Precipation forecast total**: The total expected precipitation/rain in mm within the given time-frame. The total expected rain in the configured time-frame will be equal to _precipitation_forecast_total_/_timeframe_ mm/min. So, with time-frame configured to 30 minutes and a value of 5, the expected rain is 5 mm in 30 minutes, which is the same as 10 mm/h. If time-frame is set to 90 minutes and a value of 5, the expected rain is 5 mm in 90 minutes, which is equal to 3.3 mm/h.
69-
- **Irradiance**: "Sun intensity in Watt per square meter ([W/m2](https://en.wikipedia.org/wiki/W/m2))."
70-
- **Rain last 24h**: The rain over the last 24 hours (in mm).
71-
- **Rain last hour**: The rain over the last hour (in mm).
72-
- **Temperature n days ahead**: "The forecasted temperature n days ahead (in [C](https://en.wikipedia.org/wiki/Celsius))."
73-
- **Minimum temperature n days ahead**: "The forecasted minimum temperature n days ahead (in [C](https://en.wikipedia.org/wiki/Celsius))."
74-
- **Rain chance n days ahead**: The forecasted chance for rain n days ahead (%).
75-
- **Sun chance n days ahead**: The forecasted chance for sun n days ahead (%).
76-
- **Rain n days ahead**: "The forecasted amount of rain in [mm](https://en.wikipedia.org/wiki/Millimeter) n days ahead; the average of minrain_1d and maxrain_1d."
77-
- **Minimum rain n days ahead**: "The minimum forecasted amount of rain in [mm](https://en.wikipedia.org/wiki/Millimeter) n days ahead."
78-
- **Maximum rain n days ahead**: "The maximum forecasted amount of rain in [mm](https://en.wikipedia.org/wiki/Millimeter) n days ahead."
79-
- **Wind azimuth n days ahead**: Where the wind is coming from in degrees, with true north at 0° and progressing clockwise for n days ahead. (derived from winddirection_1d)
80-
- **Wind direction n days ahead**: "Where the wind will be coming from n days ahead: N (North), Z (south), NO (North-East), etc."
81-
- **Wind force n days ahead**: "The expected windforce in [Bft](https://en.wikipedia.org/wiki/Beaufort_scale) n days ahead."
82-
- **Wind speed n days ahead**: "The expected windspeed in [m/s](https://en.wikipedia.org/wiki/M/s) n days ahead (derived from windforce_1d)."
83-
- **Condition code n days ahead**: Symbol and condition code of the expected condition n days ahead.
84-
- **Condition n days ahead**: Symbol and expected condition n days ahead.
85-
- **Detailed condition n days ahead**: Symbol and detailed expected condition n days ahead.
86-
- **Full condition (english) n days ahead**: Symbol and full expected condition n days ahead (in English).
87-
- **Full condition (dutch) n days ahead**: Symbol and full expected condition n days ahead (in Dutch).
47+
- **Station name**: The name of the selected meteo-station
48+
- **Barometer forecast**: A numeric barometric forecast (1 to 7)
49+
- **Barometer forecast name**: A textual representation of the barometer forecast (eg: Thunderstorms, Stable, etc.)
50+
- **Condition code**: A symbol and a unique code identifying the current weather condition (`[a..z]`)
51+
- **Condition**: A symbol and the current weather condition (`clear`, `cloudy`, `fog`, `rainy`, `snowy` or `lightning`)
52+
- **Condition detailed**: A symbol and detailed current weather condition (`clear`, `partlycloudy`, `cloudy`, `partlycloudy-fog`, `partlycloudy-light-rain`, `partlycloudy-rain`, `light-rain`, `rainy`, `snowy-rainy`, `partlycloudy-light-snow`, `partlycloudy-snow`, `light-snow`, `snowy`, `partlycloudy-lightning` or `lightning`)
53+
- **Condition exact**: A symbol with the full current weather condition (in English)
54+
- **Symbol**: A symbol for the current weather with the full current condition (in Dutch)
55+
- **Feel temperature**: The current wind chill factor (in [°C](https://en.wikipedia.org/wiki/Celsius))
56+
- **Humidity**: The relative humidity (in %)
57+
- **Temperature**: The current temperature (in [°C](https://en.wikipedia.org/wiki/Celsius))
58+
- **Ground temperature**: The current ground temperature (in [°C](https://en.wikipedia.org/wiki/Celsius))
59+
- **Wind speed**: The wind speed (in [km/h](https://en.wikipedia.org/wiki/Kilometres_per_hour))
60+
- **Wind force**: The wind speed/force (in [Bft](https://en.wikipedia.org/wiki/Beaufort_scale))
61+
- **Wind direction**: Where the wind is coming from: N (North), Z (south), NO (North-East), etc.
62+
- **Wind azimuth**: Where the wind is coming from in degrees, with true north at 0° and progressing clockwise
63+
- **Pressure**: The sea-level air pressure (in [hPa](https://en.wikipedia.org/wiki/Hectopascal))
64+
- **Visibility**: Visibility (in [m](https://en.wikipedia.org/wiki/Metre))
65+
- **Wind gust**: The wind speed of wind gusts ([km/h](https://en.wikipedia.org/wiki/Kilometres_per_hour))
66+
- **Precipitation**: The amount of precipitation/rain (in mm/h)
67+
- **Precipitation forecast average**: The average expected precipitation/rain within the given time-frame (in mm/h)
68+
- **Precipitation forecast total**: The total expected precipitation/rain in mm within the given time-frame. The total expected rain in the configured time-frame will be equal to _precipitation_forecast_total_/_timeframe_ mm/min. So, with time-frame configured to 30 minutes and a value of 5, the expected rain is 5 mm in 30 minutes, which is the same as 10 mm/h. If time-frame is set to 90 minutes and a value of 5, the expected rain is 5 mm in 90 minutes, which is equal to 3.3 mm/h.
69+
- **Irradiance**: Sun intensity in Watt per square meter ([W/m2](https://en.wikipedia.org/wiki/W/m2))
70+
- **Rain last 24h**: The rain over the last 24 hours (in [mm](https://en.wikipedia.org/wiki/Millimeter))
71+
- **Rain last hour**: The rain over the last hour (in [mm](https://en.wikipedia.org/wiki/Millimeter))
72+
- **Temperature n days ahead**: The forecasted temperature n days ahead (in [°C](https://en.wikipedia.org/wiki/Celsius))
73+
- **Minimum temperature n days ahead**: The forecasted minimum temperature n days ahead (in [°C](https://en.wikipedia.org/wiki/Celsius))
74+
- **Rain chance n days ahead**: The forecasted chance for rain n days ahead (in %)
75+
- **Sun chance n days ahead**: The forecasted chance for sun n days ahead (in %)
76+
- **Rain n days ahead**: The forecasted amount of rain (in [mm](https://en.wikipedia.org/wiki/Millimeter)) n days ahead; the average of `Minimum rain n days ahead` and `Maximum rain n days ahead`
77+
- **Minimum rain n days ahead**: The minimum forecasted amount of rain (in [mm](https://en.wikipedia.org/wiki/Millimeter)) n days ahead
78+
- **Maximum rain n days ahead**: The maximum forecasted amount of rain (in [mm](https://en.wikipedia.org/wiki/Millimeter)) n days ahead
79+
- **Wind azimuth n days ahead**: Where the wind is coming from in degrees, with true north at 0° and progressing clockwise for n days ahead (derived from `Wind direction n days ahead`)
80+
- **Wind direction n days ahead**: Where the wind will be coming from n days ahead: N (North), Z (south), NO (North-East), etc.
81+
- **Wind force n days ahead**: The expected wind force (in [Bft](https://en.wikipedia.org/wiki/Beaufort_scale)) n days ahead
82+
- **Wind speed n days ahead**: The expected wind speed (in [m/s](https://en.wikipedia.org/wiki/M/s)) n days ahead (derived from `Wind force n days ahead`)
83+
- **Condition code n days ahead**: Symbol and condition code of the expected condition n days ahead
84+
- **Condition n days ahead**: Symbol and expected condition n days ahead
85+
- **Detailed condition n days ahead**: Symbol and detailed expected condition n days ahead
86+
- **Full condition (english) n days ahead**: Symbol and full expected condition n days ahead (in English)
87+
- **Full condition (dutch) n days ahead**: Symbol and full expected condition n days ahead (in Dutch)
8888

8989
{% include integrations/option_flow.md %}
9090

@@ -98,5 +98,9 @@ timeframe:
9898
description: Minutes to look ahead for precipitation forecast sensors (minimum 5, maximum 120).
9999
{% endconfiguration_basic %}
100100

101-
_[Usage statement:](https://www.buienradar.nl/overbuienradar/gratis-weerdata)
102-
Buienradar makes free weather data available for use by individuals and businesses (website/intranet). The use of the weather data is allowed for **non-commercial purposes**. Please refer to the full usage statement linked above to confirm your use or to request permission._
101+
<div class='note'>
102+
103+
**Usage statement**
104+
Buienradar makes free weather data available for use by individuals and businesses (website/intranet). The use of the weather data is allowed for **non-commercial purposes**. Please refer to the [full usage statement](https://www.buienradar.nl/overbuienradar/gratis-weerdata) to confirm your use or to request permission.
105+
106+
</div>

source/_integrations/camera.markdown

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ The `Preload stream` option will start the camera feed on Home Assistant startup
2121
Example showing the Preload Stream option in the camera dialog.
2222
</p>
2323

24-
2524
### Services
2625

2726
Once loaded, the `camera` platform will expose services that can be called to perform various actions.

source/_integrations/cast.markdown

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ cast_downstairs_on_kitchen:
4444
view_path: downstairs
4545
service: cast.show_lovelace_view
4646
```
47+
4748
<div class='note'>
4849
4950
Home Assistant Cast requires your Home Assistant installation to be accessible via `https://`. If you're using Home Assistant Cloud, you don't need to do anything. Otherwise you must make sure that you have configured the `external_url` in your [configuration](/docs/configuration/basic).
@@ -145,7 +146,7 @@ Optional:
145146

146147
- `media_type`: Media type, e.g. `video/mp4`, `audio/mp3`, `image/jpeg`, defaults to `video/mp4`.
147148

148-
#### Example:
149+
#### Example
149150

150151
```yaml
151152
'cast_bubbleupnp_to_my_chromecast':
@@ -178,7 +179,7 @@ Optional:
178179
- `enqueue`: Enqueue only
179180
- `playlist_id`: Play video with `media_id` from this playlist
180181

181-
#### Example:
182+
#### Example
182183

183184
```yaml
184185
'cast_youtube_to_my_chromecast':
@@ -201,16 +202,18 @@ Optional:
201202
#### Media parameters
202203

203204
Mandatory:
205+
204206
- `app_name`: `supla`
205207
- `media_id`: Supla item ID
206208

207-
208209
Optional:
210+
209211
- `is_live`: Item is a livestream
210212

211-
#### Example:
213+
#### Example
212214

213215
Example values to cast the item at <https://www.supla.fi/audio/3601824>
216+
214217
```yaml
215218
'cast_supla_to_my_chromecast':
216219
alias: "Cast supla to My Chromecast"
@@ -258,7 +261,7 @@ Optional:
258261

259262
- `is_live`: Item is a live stream
260263

261-
#### Example:
264+
#### Example
262265

263266
Example values to cast [BBC Radio 1](https://www.bbc.co.uk/sounds/play/live:bbc_radio_one)
264267

@@ -290,8 +293,10 @@ This app doesn't retrieve its own metadata, so if you want the cast interface or
290293

291294
Note: Media ID is NOT the 8 digit alphanumeric in the URL, it can be found by right-clicking the playing video. E.g., [this episode](https://www.bbc.co.uk/iplayer/episode/b09w7fd9/bitz-bob-series-1-1-castle-makeover) shows:
292295

293-
2908kbps | dash (mf_cloudfront_dash_https)
294-
b09w70r2 | 960x540
296+
| | |
297+
| --- | --- |
298+
| 2908kbps | dash (mf_cloudfront_dash_https) |
299+
| b09w70r2 | 960x540 |
295300

296301
With b09w70r2 being the `media_id`
297302

@@ -306,7 +311,7 @@ Optional:
306311

307312
- `is_live`: Item is a live stream
308313

309-
#### Example:
314+
#### Example
310315

311316
Example values to cast [this episode](https://www.bbc.co.uk/iplayer/episode/b09w7fd9/bitz-bob-series-1-1-castle-makeover)
312317

source/_integrations/channels.markdown

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ The Channels platform allows you to control [Channels](https://getchannels.com/)
1414

1515
Your favorite channels will appear as sources in the Source List in Home Assistant.
1616

17+
## Configuration
18+
1719
To add Channels to your installation, add the following to your `configuration.yaml` file:
1820

1921
```yaml
@@ -49,7 +51,6 @@ Seek forward by the number of seconds currently set in settings on the instance
4951
| ---------------------- | -------- | ----------- |
5052
| `entity_id` | no | String that points at `entity_id` of Channels app.
5153

52-
5354
### Service `seek_backward`
5455

5556
Seek backward by the number of seconds currently set in settings on the instance of Channels.

source/_integrations/cisco_webex_teams.markdown

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,22 @@ ha_platforms:
1414

1515
The `cisco_webex_teams` notification platform allows you to deliver rich notifications from Home Assistant to [Cisco Webex Teams](https://www.webex.com/team-collaboration.html) (formerly known as Cisco Spark).
1616

17-
To use this notification platform you will need an app (bot) token. To obtain a token visit [Cisco Webex for Developers](https://developer.webex.com/).
17+
To use this notification platform you will need an app (bot) token. To obtain a token visit [Cisco Webex for Developers](https://developer.webex.com/).
18+
1819
* Detailed instructions can be found in the section titled **Creating a Webex Teams Bot** on the [Webex Teams bot documentation](https://developer.webex.com/docs/bots).
1920

2021
You also need to specify the `room_id` that you wish to post messages into. The `room_id` can be found in one of two ways:
2122

22-
1. Logging in at [Cisco Webex for Developers](https://developer.webex.com/) and navigate to `Documentation`>`API Reference`>`Messages` and select List Messages, or
23-
2. Log into the web client at [teams.webex.com](https://teams.webex.com/),
24-
* select the room (or create a new room),
25-
* then copying the room ID from the URL.
26-
27-
<strong>**Note:** you must add the bot email (in the format `mybot@webex.bot`) as a participant to the room specified above.</strong>
23+
1. Logging in at [Cisco Webex for Developers](https://developer.webex.com/) and navigate to `Documentation`>`API Reference`>`Messages` and select List Messages, or
24+
2. Log into the web client at [teams.webex.com](https://teams.webex.com/),
25+
* select the room (or create a new room),
26+
* then copying the room ID from the URL.
27+
28+
<div class='note'>
29+
30+
You must add the bot email (in the format `mybot@webex.bot`) as a participant to the room specified above.
31+
32+
</div>
2833

2934
To enable this platform in your installation, add the following to your `configuration.yaml` file:
3035

@@ -39,7 +44,7 @@ notify:
3944
4045
## Rich Text Formatting
4146
42-
Webex Teams clients can render rich text via a whitelisted set of html tags.
47+
Webex Teams clients can render rich text via a whitelisted set of html tags.
4348
4449
For example, you could configure automations to display details in an easy to read fashion like so:
4550
@@ -113,8 +118,8 @@ Here are the automations for the above screenshot:
113118
The following is a list of the allowed html tags and attributes:
114119
115120
Tag | More Info
116-
--- | ---
117-
`<@personEmail:email@examplecompany.com>` | Used to tag another Webex Team user by email address.
121+
--- | ---
122+
`<@personEmail:email@examplecompany.com>` | Used to tag another Webex Team user by email address.
118123
`<a>` | Defines a hyperlink. Allows attribute `href`.
119124
`<blockquote>` | Defines a section that is quoted from another source. Allows attribute `class` with allowed values `danger`, `warning`, `info`, `primary`, `secondary`.
120125
`<b>` | Defines bold text.

source/_integrations/citybikes.markdown

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ stations:
5252
type: list
5353
{% endconfiguration %}
5454

55-
5655
## Example
5756

5857
Additional configuration samples:

source/_integrations/climate.mqtt.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -357,11 +357,11 @@ value_template:
357357
required: false
358358
{% endconfiguration %}
359359

360-
#### Optimistic mode
360+
## Optimistic mode
361361

362362
If a property works in *optimistic mode* (when the corresponding state topic is not set), Home Assistant will assume that any state changes published to the command topics did work and change the internal state of the entity immediately after publishing to the command topic. If it does not work in optimistic mode, the internal state of the entity is only updated when the requested update is confirmed by the device through the state topic.
363363

364-
#### Using Templates
364+
## Using Templates
365365

366366
For all `*_state_topic`s, a template can be specified that will be used to render the incoming payloads on these topics. Also, a default template that applies to all state topics can be specified as `value_template`. This can be useful if you received payloads are e.g., in JSON format. Since in JSON, a quoted string (e.g., `"foo"`) is just a string, this can also be used for unquoting.
367367

@@ -386,9 +386,9 @@ climate:
386386

387387
This will parse the incoming `"auto"` as JSON, resulting in `auto`. Obviously, in this case you could also just set `value_template: {% raw %}"{{ value_json }}"{% endraw %}`.
388388

389-
Similarly for `*_command_topic`s, a template can be specified to render the outgoing payloads on these topics.
389+
Similarly for `*_command_topic`s, a template can be specified to render the outgoing payloads on these topics.
390390

391-
### Example
391+
## Example
392392

393393
A full configuration example looks like the one below.
394394

0 commit comments

Comments
 (0)