mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-30 14:56:50 +00:00
43 lines
2.0 KiB
Markdown
43 lines
2.0 KiB
Markdown
---
|
|
layout: page
|
|
title: "Website home-assistant.io"
|
|
description: "home-assistant.io web presence"
|
|
date: 2015-06-17 08:00
|
|
sidebar: false
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
---
|
|
|
|
The home of Home Assistant is [https://home-assistant.io](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 using [Octopress](http://octopress.org/). To get more details, please checkout the [documentation](http://octopress.org/docs/). That means that creating a new page is simple. The pages are written in [markdown](http://daringfireball.net/projects/markdown/), you don't need to care about HTML or alike.
|
|
|
|
To work on the website the process is no different to working on Home Assistant itself.
|
|
|
|
- Fork the home-assistant.io [git repository](https://github.com/balloob/home-assistant.io).
|
|
- Create/edit/update a page.
|
|
- To test changes to home-assistant.io locally, run ``rake preview`` and navigate to http://127.0.0.1:4000.
|
|
- Create a Pull Request against the **master** branch of home-assistant.io.
|
|
|
|
For a component page it would be the fastest way to make a copy of an existing page and edit it.
|
|
|
|
## Code
|
|
To take advantage of the build-in features of Octopress to display code snipplets, just use the default markdown syntax.
|
|
|
|
```bash
|
|
Here goes the code...
|
|
```
|
|
|
|
## Images, icons, and logos
|
|
The images which are displayed on the pages are stored in various directories according their purpose.
|
|
|
|
| Type | Location |
|
|
| :----------- |:----------------------------------------------|
|
|
| screen shots | source/images/screenshots |
|
|
| logos | source/images/supported_brands |
|
|
|
|
No everything has a logo, to show something we are using the [Gnome Icon Theme](http://ftp.gnome.org/pub/GNOME/sources/gnome-icon-theme) from the [GNOME Project](http://www.gnome.org) as a source for the placeholders. Those icon are licensed under the GNU LGPL v.3 or Creative Commons BY-SA 3.0 license.
|
|
|
|
|