1. To add a new device create a new folder and a markdown (.md) file both named after your device under the _devices directory in the GitHub Repository. Please avoid using underscores in the filenames and use hypens instead as this makes for easier to understand the URLs generated when the site is built. When using the Add file -> Create new file button in the _devices folder or by following this link, Github will automatically create a fork of the repository and a new branch for your changes. Just type the device name for the folder followed by a slash (/) and the device name (again) as the filename plus the .md suffix.


  2. Once you have written your file commit your changes and raise a pull request on GitHub. A guide for creating a pull request from a fork can be found here if you are unsure.

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
date-published: 2019-10-11
type: plug
standard: uk, us
Field Description Allowable Options Required?
title Device Title   Yes
date-published Date Published Formatting: YYYY-MM-DD HH:MM:SS +/-TTTT (Time and Timezone offset are optional) Yes
type Type of Device plug, light, switch, dimmer , relay, sensor, misc Yes
standard Electrical standard country uk, us, eu, au, global Yes


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 folder using the appropriate markdown syntax:
  ![alt text](/assets/images/your-folder-name/your-image.jpg "Image Hover Text")

Image Sizes

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