[miio] update readme #4780
[miio] update readme #4780
Conversation
| @@ -926,6 +927,15 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena | |||
| | led | Switch | Wifi led | | |||
|
|
|||
|
|
|||
| ### Mi Power-plug (<a name="chuangmi-plug-m3">chuangmi.plug.m3</a>) Channels | |||
|
|
|||
There was a problem hiding this comment.
This line could be removed.
| |------------------|---------|-------------------------------------| | ||
| | power | Switch | Power | | ||
| | temperature | Number | Temperature | | ||
|
|
There was a problem hiding this comment.
This line could be removed.
| @@ -2173,6 +2183,16 @@ Number temperature "Temperature" (G_plug) {channel="miio:basic:plug:temperature" | |||
| Switch led "Wifi led" (G_plug) {channel="miio:basic:plug:led"} | |||
| ``` | |||
|
|
|||
| ### Mi Power-plug (chuangmi.plug.m3) item file lines | |||
|
|
|||
There was a problem hiding this comment.
This line could be removed.
|
|
||
|
|
||
| note: Autogenerated example. Replace the id (plug) in the channel with your own. Replace `basic` with `generic` in the thing UID depending on how your thing was discovered. | ||
| ``` |
There was a problem hiding this comment.
Please add a newline before the codeblock and add a language like ```java
|
@Confectrician are you 100% sure that without these blank lines it will work with Jekyll. Before it caused some issues... |
|
We don't use jekyll anymore for the website build, so keeping just one newline should be fine. I am sure the code blocks would even work without any newline too, but the empty lines between a paragraph and codeblocks/headlines, have evolved to a kind of styleguide now. I have asked the other documentation maintainers how we have to (or should) handle the code block language tags in the future. |
Signed-off-by: Marcel Verpaalen <[email protected]>
marcelrv
force-pushed
the
miio-readmeUpdate
branch
from
1e0ac46 to
afae766
Compare
|
as your remarks basically apply to the rest of the readme as well it is updated for the other items as well |
Signed-off-by: Marcel Verpaalen <[email protected]> Signed-off-by: Pshatsillo <[email protected]>
Signed-off-by: Marcel Verpaalen <[email protected]> Signed-off-by: Maximilian Hess <[email protected]>
Update readme
Signed-off-by: Marcel Verpaalen [email protected]