The website you’re reading now is the home of Home Assistant: https://home-assistant.io. This is the place where we provide documentation and additional details about Home Assistant for end users and developers.
-home-assistant.io uses the Octopress framework for Jekyll. To get more details, please checkout the Octopress documentation. -That means that creating a new page is simple. The pages are written in markdown; you don’t need to care about HTML or the like.
+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.
+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):
@@ -116,20 +115,23 @@ That means that creating a new page is simple. The pages are written in For 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. -To take advantage of the built-in features of Octopress to display code snippets, just use the default markdown syntax. Please use $ and # if it’s a command and to differ from output.
Here goes the 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 like this:
+
+\`\`\`yaml
+sensor:
+ platform: template
+\`\`\`
-If you want to display line numbers, add the following snippet somewhere on your page.
+Note that you can replace text next to ``` with the language that is within the block.
-{::options coderay_line_numbers="table" /}
-
-
+When you’re writing code that is to be executed on the terminal, prefix it with $.
Images, icons, and logos
+
The images which are displayed on the pages are stored in various directories according to their purpose.