Skip to content

Latest commit

 

History

History
36 lines (23 loc) · 1.67 KB

README.md

File metadata and controls

36 lines (23 loc) · 1.67 KB

esphome-devices.com

Netlify Status

A database of configuration files and guides for devices commonly flashed with https://esphome.io firmware.

Go to https://www.esphome-devices.com to view the website.

How To Contribute

Content on www.esphome-devices.com is generated by Gatsby. Pages are written in Markdown which anyone can learn. How to add a new device is documented here.

When you create a merge request, Netlify will automatically compile your proposed changes for you to preview what gets rendered. It puts a comment in the PR on Github.

If you want to build the site locally:

# Install NodeJS if you haven't already. Assuming you are using Ubuntu:
curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash -
sudo apt-get install -y nodejs
# Now install gatsby as configured in the esphome-devices repository:
npm install
# Run a development gatsby server so you can see your copy of the site:
gatsby develop
# Open a browser to http://localhost:8000/

You can learn more about Gatsby develop mode here.

Code of Conduct

When contributing to this project please abide by our Code of Conduct

This is a fork, join our effort

This is a fork of https://github.com/jonathanadams/esphome-configs. The goal is to involve more members of the ESPHome community to more actively update the devices! Please contact us or submit an issue if you are interested!