mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-29 12:17:01 +00:00
Use component and platform for link id in configuration blocks (#40123)
This commit is contained in:
parent
ce321411ee
commit
63597f5dd7
@ -166,10 +166,16 @@ module Jekyll
|
|||||||
|
|
||||||
vars = SafeYAML.load(contents)
|
vars = SafeYAML.load(contents)
|
||||||
|
|
||||||
|
linkId = [component, platform, 'configuration-variables']
|
||||||
|
.compact
|
||||||
|
.reject(&:empty?)
|
||||||
|
.join('-')
|
||||||
|
|
||||||
|
|
||||||
<<~MARKUP
|
<<~MARKUP
|
||||||
<div class="config-vars">
|
<div class="config-vars">
|
||||||
<h4>
|
<h4>
|
||||||
Configuration Variables <a class="title-link" name="configuration-variables" href="#configuration-variables"></a>
|
Configuration Variables <a class="title-link" name="#{linkId}" href="##{linkId}"></a>
|
||||||
</h4>
|
</h4>
|
||||||
<div class="configuration-link">
|
<div class="configuration-link">
|
||||||
<a href="/docs/configuration/" target="_blank">Looking for your configuration file?</a>
|
<a href="/docs/configuration/" target="_blank">Looking for your configuration file?</a>
|
||||||
|
@ -140,7 +140,7 @@ template:
|
|||||||
|
|
||||||
### Configuration reference
|
### Configuration reference
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration trigger-based %}
|
||||||
actions:
|
actions:
|
||||||
description: Define actions to be executed when the trigger fires (for trigger-based entities only). Optional. Variables set by the action script are available when evaluating entity templates. This can be used to interact with anything using actions, in particular actions with [response data](/docs/scripts/perform-actions#use-templates-to-handle-response-data). [See action documentation](/docs/automation/action).
|
description: Define actions to be executed when the trigger fires (for trigger-based entities only). Optional. Variables set by the action script are available when evaluating entity templates. This can be used to interact with anything using actions, in particular actions with [response data](/docs/scripts/perform-actions#use-templates-to-handle-response-data). [See action documentation](/docs/automation/action).
|
||||||
required: false
|
required: false
|
||||||
@ -193,7 +193,7 @@ template:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration device %}
|
||||||
availability:
|
availability:
|
||||||
description: Defines a template to get the `available` state of the entity. If the template either fails to render or returns `True`, `"1"`, `"true"`, `"yes"`, `"on"`, `"enable"`, or a non-zero number, the entity will be `available`. If the template returns any other value, the entity will be `unavailable`. If not configured, the entity will always be `available`. Note that the string comparison is not case sensitive; `"TrUe"` and `"yEs"` are allowed.
|
description: Defines a template to get the `available` state of the entity. If the template either fails to render or returns `True`, `"1"`, `"true"`, `"yes"`, `"on"`, `"enable"`, or a non-zero number, the entity will be `available`. If the template returns any other value, the entity will be `unavailable`. If not configured, the entity will always be `available`. Note that the string comparison is not case sensitive; `"TrUe"` and `"yEs"` are allowed.
|
||||||
required: false
|
required: false
|
||||||
@ -268,7 +268,7 @@ template:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration alarm_control_panel %}
|
||||||
alarm_control_panel:
|
alarm_control_panel:
|
||||||
description: List of alarm control panels
|
description: List of alarm control panels
|
||||||
required: true
|
required: true
|
||||||
@ -349,7 +349,7 @@ template:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration binary-sensor %}
|
||||||
binary_sensor:
|
binary_sensor:
|
||||||
description: List of binary sensors
|
description: List of binary sensors
|
||||||
required: true
|
required: true
|
||||||
@ -536,7 +536,7 @@ template:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration button %}
|
||||||
button:
|
button:
|
||||||
description: List of buttons
|
description: List of buttons
|
||||||
required: true
|
required: true
|
||||||
@ -591,7 +591,7 @@ template:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration cover %}
|
||||||
cover:
|
cover:
|
||||||
description: Characteristics of a cover
|
description: Characteristics of a cover
|
||||||
type: map
|
type: map
|
||||||
@ -822,7 +822,7 @@ template:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration fan %}
|
||||||
fan:
|
fan:
|
||||||
description: List of fans
|
description: List of fans
|
||||||
required: true
|
required: true
|
||||||
@ -1028,7 +1028,7 @@ template:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration image %}
|
||||||
image:
|
image:
|
||||||
description: List of images
|
description: List of images
|
||||||
required: true
|
required: true
|
||||||
@ -1161,7 +1161,7 @@ template:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration light %}
|
||||||
light:
|
light:
|
||||||
description: List of your lights.
|
description: List of your lights.
|
||||||
required: true
|
required: true
|
||||||
@ -1421,7 +1421,7 @@ template:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration lock %}
|
||||||
lock:
|
lock:
|
||||||
description: List of locks
|
description: List of locks
|
||||||
required: true
|
required: true
|
||||||
@ -1609,7 +1609,7 @@ template:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration number %}
|
||||||
number:
|
number:
|
||||||
description: List of numbers
|
description: List of numbers
|
||||||
required: true
|
required: true
|
||||||
@ -1717,7 +1717,7 @@ template:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration select %}
|
||||||
select:
|
select:
|
||||||
description: List of selects
|
description: List of selects
|
||||||
required: true
|
required: true
|
||||||
@ -1808,7 +1808,7 @@ template:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration sensor %}
|
||||||
sensor:
|
sensor:
|
||||||
description: List of sensors
|
description: List of sensors
|
||||||
required: true
|
required: true
|
||||||
@ -1971,7 +1971,7 @@ template:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration switch %}
|
||||||
switch:
|
switch:
|
||||||
description: List of switches
|
description: List of switches
|
||||||
required: true
|
required: true
|
||||||
@ -2117,7 +2117,7 @@ template:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration vacuum %}
|
||||||
vacuum:
|
vacuum:
|
||||||
description: List of vacuum entities
|
description: List of vacuum entities
|
||||||
required: true
|
required: true
|
||||||
@ -2277,7 +2277,7 @@ template:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration weather %}
|
||||||
weather:
|
weather:
|
||||||
description: List of weather entities
|
description: List of weather entities
|
||||||
required: true
|
required: true
|
||||||
@ -2647,7 +2647,7 @@ alarm_control_panel:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration legacy_alarm_control_panel %}
|
||||||
panels:
|
panels:
|
||||||
description: List of your panels.
|
description: List of your panels.
|
||||||
required: true
|
required: true
|
||||||
@ -2731,7 +2731,7 @@ binary_sensor:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration legacy_binary_sensor %}
|
||||||
sensors:
|
sensors:
|
||||||
description: List of your sensors.
|
description: List of your sensors.
|
||||||
required: true
|
required: true
|
||||||
@ -2818,7 +2818,7 @@ cover:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration legacy_cover %}
|
||||||
covers:
|
covers:
|
||||||
description: List of your covers.
|
description: List of your covers.
|
||||||
required: true
|
required: true
|
||||||
@ -2942,7 +2942,7 @@ fan:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration legacy_fan %}
|
||||||
fans:
|
fans:
|
||||||
description: List of your fans.
|
description: List of your fans.
|
||||||
required: true
|
required: true
|
||||||
@ -3078,7 +3078,7 @@ light:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration legacy_light %}
|
||||||
lights:
|
lights:
|
||||||
description: List of your lights.
|
description: List of your lights.
|
||||||
required: true
|
required: true
|
||||||
@ -3225,7 +3225,7 @@ lock:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration legacy_lock %}
|
||||||
name:
|
name:
|
||||||
description: Name to use in the frontend.
|
description: Name to use in the frontend.
|
||||||
required: false
|
required: false
|
||||||
@ -3292,7 +3292,7 @@ sensor:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration legacy_sensor %}
|
||||||
sensors:
|
sensors:
|
||||||
description: Map of your sensors.
|
description: Map of your sensors.
|
||||||
required: true
|
required: true
|
||||||
@ -3375,7 +3375,7 @@ switch:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration legacy_switch %}
|
||||||
switches:
|
switches:
|
||||||
description: List of your switches.
|
description: List of your switches.
|
||||||
required: true
|
required: true
|
||||||
@ -3437,7 +3437,7 @@ vacuum:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration legacy_vacuum %}
|
||||||
vacuums:
|
vacuums:
|
||||||
description: List of your vacuums.
|
description: List of your vacuums.
|
||||||
required: true
|
required: true
|
||||||
@ -3533,7 +3533,7 @@ weather:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration legacy_weather %}
|
||||||
name:
|
name:
|
||||||
description: Name to use in the frontend.
|
description: Name to use in the frontend.
|
||||||
required: true
|
required: true
|
||||||
|
Loading…
x
Reference in New Issue
Block a user