home-assistant.io/source/developers/website.markdown

layout, title, description, date, sidebar, comments, sharing, footer

layout	title	description	date	sidebar	comments	sharing	footer
page	Website home-assistant.io	home-assistant.io web presence	2015-06-17 08:00	true	false	true	true

The website you are 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 is built using Jekyll and those available dependencies. The pages are written in markdown; to add a page you don't need to know about HTML or the like.

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):

• Install Ruby if you don't have it already.
• Install bundler, which is a dependency manager for Ruby: gem install bundler
• In your home-assistant.github.io root directory, run bundle to install the gems you need.

Then you can work on the documentation:

• Fork home-assistant.io git repository.
• Create/edit/update a page in the directory source/_components/ for your platform/component.
• Test your changes to home-assistant.io locally: run rake preview and navigate to http://127.0.0.1:4000
• Create a Pull Request (PR) against the next branch of home-assistant.github.io if your documentation is for a new feature, platform, or component.
• Create a Pull Request (PR) against the current branch of home-assistant.github.io if you fix stuff, create Cookbook entries, or expand existing documentation.

It could be necessary that you run `rake generate` prior to `rake preview` for the very first preview.

{% linkable_title Create a 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.

If you start from scratch with a page, you need to add a header. Different sections of the doumentation may need different headers.

---
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. 

{% raw %}### {% linkable_title Linkable Header %}{% endraw %}
...

There are pre-definied variables available but usually it's not necessary to use them when writing documentation.

{% linkable_title 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.

{% raw %} ```yaml
 sensor:
   platform: template
 ```{% endraw %}

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 $.

{% linkable_title 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>

{% linkable_title Images, icons, and logos %}

The images which are displayed on the pages are stored in various directories according to their purpose.

Type	Location
screenshots	source/images/screenshots
logos	source/images/supported_brands

Not everything (product, component, etc.) has a logo. To show something for internal parts of Home Assistant we are using the Material Design Icons.