Skip to content

Latest commit

 

History

History
44 lines (33 loc) · 1.83 KB

adding-devices.md

File metadata and controls

44 lines (33 loc) · 1.83 KB
Raw
layout title permalink
default
Adding Devices
/adding-devices/

Contributing: Adding Devices

To add a new device a new .md file needs to be added under the _devices directory in the GitHub Repository.

You will need to create a fork of the repository, create a new branch for your changes and then raise a pull request.

<script async defer src="https://buttons.github.io/buttons.js"></script>

Fork

YAML Front Matter

Each .md file created needs to contain front matter in order for the page to be generated. Details of the front matter required (and optional) is detailed below:

---
title: Sonoff S20
type: plug
standard: uk, us
---
Field Description Allowable Options
title Device Title
type Type of Device plug, light, switch, relay, sensor, misc
standard Electrical standard country uk, us, eu, au, global

Images

To add images to your files do the following:

  1. Create a folder with the same name as your device .md file in /assets/images and add your images to this folder.
  2. Add the images to your fold using the appropriate markdown syntax:
![alt text](/assets/img/your-folder-name/your-image.jpg "Image Hover Text")

Image Sizes

Please be considerate over image sizes to help reduce page loading times.