jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Fixed typos in some of the pages (#1270)

Browse source 
* Update architecture.markdown

* Update component_discovery.markdown

* Update development_validation.markdown

* Update frontend.markdown

* Update maintenance.markdown

* Update multiple_instances.markdown

* Update python_api.markdown

* Update releasing.markdown

* Update rest_api.markdown

* Update server_sent_events.markdown

* Update website.markdown
This commit is contained in:
KAMAL AWASTHI 2016-10-20 14:59:37 +05:30 • committed by Fabian Affolter
parent 2484dc43e3
commit 404815fae0
11 changed files with 30 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

10
source/developers/website.markdown
View file

@ -28,7 +28,7 @@ Then you can work on the documentation:
- Fork home-assistant.io [git repository](https://github.com/home-assistant/home-assistant.github.io).
- 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](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 **next** branch of home-assistant.github.io if your documentation is 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.
<p class='note'>
@ -39,7 +39,7 @@ It could be necessary that you run `rake generate` prior to `rake preview` for t
For a platform page, the fastest way is to make a copy of an existing page and edit it. The [Component overview](/components/) and the [Examples section](/cookbook/) 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.
If you start from scratch with a page, you need to add a header. Different sections of the documentation may need different headers.
```text
---
@ -59,11 +59,11 @@ Content...Written in markdown.
...
```
There are [pre-definied variables](https://jekyllrb.com/docs/variables/) available but usually it's not necessary to use them when writing documentation.
There are [pre-definied variables](https://jekyllrb.com/docs/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.
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.
```text
{% raw %} ```yaml
@ -72,7 +72,7 @@ You can use the default markdown syntax to generate syntax highlighted code. For
```{% endraw %}
```
If you are using templates then those parts needs to be [escaped](http://stackoverflow.com/a/24102537). Otherwise they will be rendered and appear blank on the website.
If you are using templates then those parts need to be [escaped](http://stackoverflow.com/a/24102537). 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.