diff --git a/atom.xml b/atom.xml index 2982823aad..a78e177f82 100644 --- a/atom.xml +++ b/atom.xml @@ -4,7 +4,7 @@
bundler
, a dependency manager for Ruby: $ gem install bundler
$ bundle
to install the gems you need.Short cut for Fedora: $ sudo dnf -y install gcc-c++ ruby ruby-devel rubygem-bundler && bundle
Short cut for Fedora: $ sudo dnf -y install gcc-c++ ruby ruby-devel rubygem-bundler rubygem-json && bundle
Then you can work on the documentation:
Required
options. Full configuration details with further explanations should go into a seperate section.ha_release
part of the header, just increment off the current release. If the current release is 0.37, make ha_release
0.38.ha_release
part of the header, just increment of the current release. If the current release is 0.37, make ha_release
0.38. If it’s 0.30 or 0.40 please quote it with " "
.You can use the default markdown syntax to generate syntax highlighted code. For inline code wrap your code in `. For multi-line, syntax wrap your code as shown below.
- ```yaml
- sensor:
- platform: template
+ Configuration variables
+The Configuration Variables section must use the {% configuration %} ... {% endconfiguration %}
tag.
+
+{% configuration %}
+ api_key:
+ description: The API key to access the service.
+ required: true
+ type: string
+ name:
+ description: Name to use in the frontend.
+ required: false
+ type: string
+{% endconfiguration %}
+
-
-Note that you can replace `yaml` next to \`\`\` with the language that is within the block.
-
-When you're writing code that is to be executed on the terminal, prefix it with `$`.
-
-### <a class='title-link' name='templates' href='#templates'></a> Templates
-
-For the [configuration templating](/topics/templating/) is [Jinja](http://jinja.pocoo.org/) used.
-
-If you are using templates then those parts needs to be [escaped](http://stackoverflow.com/a/24102537). Otherwise they will be rendered and appear blank on the website.
-
-### <a class='title-link' name='html' href='#html'></a> HTML
-
-The direct usage of HTML is supported but not recommended. The note boxes are an exception.
-
-```html
-<p class='note warning'>
+
+ description:
: That the variable is about.
+ required:
: If the variable is required.
+ required: true #=> Required
+required: false #=> Optional
+required: inclusive #=> Inclusive
+required: exclusive #=> Exclusive
+required: any string here #=> Any string here
+
+
+
+ type:
: The type of the variable. Allowed entries: string
, int
or map
. For multiple possibilities use [string, int]
. If you use map
then you need to define keys:
(see the template
sensor for an example).
+
+ Embedding Code
+You can use the default markdown syntax to generate syntax highlighted code. For inline code wrap your code in `.
+When you’re writing code that is to be executed on the terminal, prefix it with $
.
+ Templates
+For the configuration templating is Jinja used.
+If you are using templates then those parts needs to be escaped. Otherwise they will be rendered and appear blank on the website.
+ HTML
+The direct usage of HTML is supported but not recommended. The note boxes are an exception.
+<p class='note warning'>
You need to enable telnet on your router.
-</p>
+</p>
Redirects
-If you rename or move an existing platform or component, create the redirect. Add the old location of the page to the header of the new one.
---
+If you rename or move an existing platform or component, create the redirect. Add the old location of the page to the header of the new one.
+---
...
redirect_from: /getting-started/android/
---
+
Images, icons, and logos
The images which are displayed on the pages are stored in various directories according to their purpose.
diff --git a/sitemap.xml b/sitemap.xml
index f3923c3307..dde0ee814f 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -3374,7 +3374,7 @@
https://home-assistant.io/components/switch.hook/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/cookbook/automation_for_rainy_days/
@@ -4006,99 +4006,99 @@
https://home-assistant.io/docs/autostart/init.d/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/docs/ecosystem/appdaemon/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/docs/ecosystem/appdaemon/api/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/docs/ecosystem/appdaemon/configuration/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/docs/ecosystem/appdaemon/example_apps/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/docs/ecosystem/appdaemon/installation/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/docs/ecosystem/appdaemon/operation/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/docs/ecosystem/appdaemon/reboot/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/docs/ecosystem/appdaemon/running/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/docs/ecosystem/appdaemon/tutorial/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/docs/ecosystem/appdaemon/updating/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/docs/ecosystem/appdaemon/windows/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/docs/ecosystem/certificates/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/docs/ecosystem/hadashboard/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/docs/ecosystem/hass-configurator/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/docs/ecosystem/ios/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/docs/ecosystem/nginx/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/docs/ecosystem/notebooks/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/docs/ecosystem/scenegen/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/docs/ecosystem/synology/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/docs/tools/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/docs/tools/dev-tools/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/docs/tools/hass/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/docs/tools/scripts/
-2017-09-30T09:34:24+00:00
+2017-09-30T11:26:53+00:00
https://home-assistant.io/faq/after-upgrading/
@@ -5118,62 +5118,62 @@
https://home-assistant.io/demo/frontend.html
-2017-09-30T09:33:41+00:00
+2017-09-30T11:26:15+00:00
https://home-assistant.io/demo/index.html
-2017-09-30T09:33:41+00:00
+2017-09-30T11:26:15+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-event.html
-2017-09-30T09:33:41+00:00
+2017-09-30T11:26:15+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-info.html
-2017-09-30T09:33:41+00:00
+2017-09-30T11:26:15+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-service.html
-2017-09-30T09:33:41+00:00
+2017-09-30T11:26:15+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-state.html
-2017-09-30T09:33:41+00:00
+2017-09-30T11:26:15+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-template.html
-2017-09-30T09:33:41+00:00
+2017-09-30T11:26:15+00:00
https://home-assistant.io/demo/panels/ha-panel-history.html
-2017-09-30T09:33:41+00:00
+2017-09-30T11:26:15+00:00
https://home-assistant.io/demo/panels/ha-panel-iframe.html
-2017-09-30T09:33:41+00:00
+2017-09-30T11:26:15+00:00
https://home-assistant.io/demo/panels/ha-panel-logbook.html
-2017-09-30T09:33:41+00:00
+2017-09-30T11:26:15+00:00
https://home-assistant.io/demo/panels/ha-panel-map.html
-2017-09-30T09:33:41+00:00
+2017-09-30T11:26:15+00:00
https://home-assistant.io/googlef4f3693c209fe788.html
-2017-09-30T09:33:41+00:00
+2017-09-30T11:26:15+00:00
https://home-assistant.io/static/fonts/roboto/DESCRIPTION.en_us.html
-2017-09-30T09:33:41+00:00
+2017-09-30T11:26:15+00:00
https://home-assistant.io/static/fonts/robotomono/DESCRIPTION.en_us.html
-2017-09-30T09:33:41+00:00
+2017-09-30T11:26:16+00:00
https://home-assistant.io/static/mdi-demo.html
-2017-09-30T09:33:41+00:00
+2017-09-30T11:26:16+00:00