652b09d159 | ||
---|---|---|
.devcontainer | ||
.github | ||
src | ||
static | ||
.gitignore | ||
.markdownlintrc | ||
.yamllintrc | ||
CODE-OF-CONDUCT.md | ||
LICENSE | ||
README.md | ||
gatsby-config.js | ||
package-lock.json | ||
package.json |
README.md
ESPHome Devices
A database of configuration files and guides for devices commonly flashed with https://esphome.io firmware.
Go to https://devices.esphome.io to view the website.
How To Contribute
Content on devices.esphome.io 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.
Development of site
The site requires Node 18 to build. Once that is running, to build locally:
# 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:
npm run start
# 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 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!