Update configuration description style (#3994)

This commit is contained in:
Fabian Affolter 2017-11-16 21:05:16 +01:00 committed by GitHub
parent 8dba93493a
commit 85fcddbf17
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 160 additions and 56 deletions

View file

@ -28,9 +28,24 @@ sensor:
quote: EUR
```
Configuration variables:
{% configuration %}
name:
description: The name of the sensor.
required: false
type: string
default: Exchange Rate Sensor
api_key:
description: "The API Key for [Open Exchange Rates](https://openexchangerates.org)."
required: true
type: string
quote:
description: The symbol of the quote or target currency.
required: true
type: string
base:
description: The symbol of the base currency.
required: false
type: string
default: USD
{% endconfiguration %}
- **api_key** (*Required*): API Key for [Open Exchange Rates](https://openexchangerates.org).
- **quote** (*Required*): The symbol of the quote or target currency.
- **name** (*Optional*): Name to use in the frontend.
- **base** (*Optional*): The symbol of the base currency. Defaults to USD.