Skip to content

Commit c122c67

Browse files
balloobballoob
committed
Update website docs
1 parent 9527e27 commit c122c67

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

‎source/developers/website.markdown

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,11 @@ sharing: true
99
footer: true
1010
---
1111

12-
The website you're reading now is the home of Home Assistant: [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.
12+
The website you're reading now is the home of Home Assistant: [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.
1313

14-
home-assistant.io uses the [Octopress](http://octopress.org/) framework for [Jekyll](http://github.com/mojombo/jekyll). To get more details, please checkout the [Octopress documentation](http://octopress.org/docs/).
15-
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 the like.
14+
home-assistant.io is built using [Jekyll](http://github.com/mojombo/jekyll). The pages are written in [markdown](http://daringfireball.net/projects/markdown/); to add a page you don't need to know about HTML or the like.
1615

17-
The process for working on the website is no different from working on Home Assistant itself.
16+
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.
1817

1918
To test your changes locally, you need to install the **Ruby** dependencies (gems):
2019

@@ -25,33 +24,35 @@ To test your changes locally, you need to install the **Ruby** dependencies (gem
2524
Then you can work on the documentation:
2625

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

3332
For a platform page, the fastest way is to make a copy of an existing page and edit it. The [component overview](/components/) is generated automatically, so there is no need to add a link to your page.
3433

35-
### {% linkable_title Code %}
36-
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.
34+
### {% linkable_title Embedding Code %}
3735

38-
```bash
39-
Here goes the code...
36+
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:
37+
38+
```text
39+
\`\`\`yaml
40+
sensor:
41+
platform: template
42+
\`\`\`
4043
```
4144

42-
If you want to display line numbers, add the following snippet somewhere on your page.
45+
Note that you can replace `text` next to \`\`\` with the language that is within the block.
4346

44-
```
45-
{::options coderay_line_numbers="table" /}
46-
```
47+
When you're writing code that is to be executed on the terminal, prefix it with `$`.
4748

4849
### {% linkable_title Images, icons, and logos %}
49-
The images which are displayed on the pages are stored in various directories according to their purpose.
50+
51+
The images which are displayed on the pages are stored in various directories according to their purpose.
5052

5153
| Type | Location |
5254
| :----------- |:----------------------------------------------|
53-
| screen shots | source/images/screenshots |
55+
| screenshots | source/images/screenshots |
5456
| logos | source/images/supported_brands |
5557

56-
Not everything (product, component, etc.) has a logo. To show something for internal parts of Home Assistant we are using the [Material Design Icons](https://materialdesignicons.com/).
57-
58+
Not everything (product, component, etc.) has a logo. To show something for internal parts of Home Assistant we are using the [Material Design Icons](https://materialdesignicons.com/).

0 commit comments

Comments
 (0)