home-assistant.io is built using Jekyll. The pages are written in markdown; to add a page you don’t need to know about HTML or the like.
-The process for working on the website is no different from working on Home Assistant itself. You work on your change and propose it via a pull request.
+The link “Edit this page on GitHub” allows one to edit pages without creating a fork.
+ +For larger changes, we suggest that you clone the website repository. This has the advantage that you can review your changes locally. The process for working on the website is no different from working on Home Assistant itself. You work on your change and propose it via a pull request.
To test your changes locally, you need to install the Ruby dependencies (gems):
bundler, which is a dependency manager for Ruby: gem install bundlerbundle to install the gems you need.bundle to install the gems you need.Then you can work on the documentation:
@@ -109,27 +111,63 @@source/_components/ for your platform/component.rake preview and navigate to http://127.0.0.1:4000For a platform page, the fastest way is to make a copy of an existing page and edit it. The component overview is generated automatically, so there is no need to add a link to your page.
+For a platform page, the fastest way is to make a copy of an existing page and edit it. The Component overview and the Examples section are generated automatically, so there is no need to add a link to those pages.
-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 like this:
+If you start from scratch with a page, you need to add a header. Different sections of the doumentation may need different headers.
-\`\`\`yaml
-sensor:
- platform: template
-\`\`\`
+---
+layout: page
+title: "Website home-assistant.io"
+description: "home-assistant.io web presence"
+date: 2015-06-17 08:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+---
+
+Content...Written in markdown.
+
+### {% linkable_title Linkable Header %}
+...
-Note that you can replace text next to ``` with the language that is within the block.
+There are pre-definied variables available but usually it’s not necessary to use them when writing documentation.
+
+ Embedding Code
+
+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
+ ```
+
+
+
+If you are using templates then those parts needs to be escaped. Otherwise they will be rendered and appear blank on the website.
+
+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 $.
+ HTML
+
+The direct usage of HTML is supported but not recommanded. The note boxes are an exception.
+
+<p class='note warning'>
+ You need to enable telnet on your router.
+</p>
+
+
+
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 0fefd5c52c..836c7f1264 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -1855,62 +1855,62 @@
https://home-assistant.io/demo/frontend.html
-2016-08-22T13:33:42+00:00
+2016-08-22T17:02:27+00:00
https://home-assistant.io/demo/index.html
-2016-08-22T13:33:42+00:00
+2016-08-22T17:02:27+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-event.html
-2016-08-22T13:33:42+00:00
+2016-08-22T17:02:27+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-info.html
-2016-08-22T13:33:42+00:00
+2016-08-22T17:02:27+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-service.html
-2016-08-22T13:33:42+00:00
+2016-08-22T17:02:27+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-state.html
-2016-08-22T13:33:42+00:00
+2016-08-22T17:02:27+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-template.html
-2016-08-22T13:33:42+00:00
+2016-08-22T17:02:27+00:00
https://home-assistant.io/demo/panels/ha-panel-history.html
-2016-08-22T13:33:42+00:00
+2016-08-22T17:02:27+00:00
https://home-assistant.io/demo/panels/ha-panel-iframe.html
-2016-08-22T13:33:42+00:00
+2016-08-22T17:02:27+00:00
https://home-assistant.io/demo/panels/ha-panel-logbook.html
-2016-08-22T13:33:42+00:00
+2016-08-22T17:02:27+00:00
https://home-assistant.io/demo/panels/ha-panel-map.html
-2016-08-22T13:33:42+00:00
+2016-08-22T17:02:27+00:00
https://home-assistant.io/googlef4f3693c209fe788.html
-2016-08-22T13:33:42+00:00
+2016-08-22T17:02:27+00:00
https://home-assistant.io/static/fonts/roboto/DESCRIPTION.en_us.html
-2016-08-22T13:33:42+00:00
+2016-08-22T17:02:27+00:00
https://home-assistant.io/static/fonts/robotomono/DESCRIPTION.en_us.html
-2016-08-22T13:33:42+00:00
+2016-08-22T17:02:27+00:00
https://home-assistant.io/static/mdi-demo.html
-2016-08-22T13:33:42+00:00
+2016-08-22T17:02:27+00:00