jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-26 10:46:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Extent sample

Browse Source
This commit is contained in:
Fabian Affolter 2017-11-05 14:05:12 +01:00
parent 70167e3d74
commit f511bea3e2
No known key found for this signature in database
GPG Key ID: DDF3D6F44AAB1336
1 changed files with 21 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
source/developers/documentation/create_page.markdown
View File

@ -49,22 +49,31 @@ Every platform page should contain a configuration sample. This sample must cont
The **Configuration Variables** section must use the {% raw %}`{% configuration %} ... {% endconfiguration %}`{% endraw %} tag. The **Configuration Variables** section must use the {% raw %}`{% configuration %} ... {% endconfiguration %}`{% endraw %} tag.
```text
{% raw %} {% raw %}
```text
{% configuration %} {% configuration %}
api_key: api_key:
description: The API key to access the service. description: The API key to access the service.
required: true required: true
type: string type: string
name: name:
description: Name to use in the frontend. description: Name to use in the frontend.
required: false required: false
default: The default name to use in the frontend. default: The default name to use in the frontend.
type: string type: string
monitored_conditions:
description: Conditions to display in the frontend.
required: true
type: list
keys:
weather:
description: A human-readable text summary.
temperature:
description: The current temperature.
{% endconfiguration %} {% endconfiguration %}
{% endraw %}
``` ```
{% endraw %}
Available keys: Available keys: