A comprehensive guide for home automation enthusiasts

This repository contains the source for the Home Automation Cookbook website, built with Jekyll and hosted on GitHub Pages.

Visit the live site at: [Your Custom Domain] (Update CNAME file)

The Home Automation Cookbook is a community-driven documentation project that helps people:

• Get started with home automation
• Choose the right platform and devices
• Create effective automations
• Secure their smart homes
• Troubleshoot common issues

• Ruby 2.7 or higher
• Bundler
• Git

1. Clone the repository:

   git clone https://github.com/yourusername/HomeAutomationCookbook.git
   cd HomeAutomationCookbook

2. Install dependencies:

   cd docs
   bundle install

3. Run the local server:

   bundle exec jekyll serve

4. Open your browser to http://localhost:4000

For convenience, you can use the provided batch file:

run-site.cmd

We welcome contributions! Here's how you can help:

1. Add Content: Create new guides or improve existing ones
2. Fix Errors: Spot a mistake? Submit a PR
3. Share Experience: Add your automation recipes
4. Improve Navigation: Help organize content better

• docs/ - Main documentation folder
  • getting-started/ - Beginner guides
  • platforms/ - Platform comparisons
  • devices/ - Device reviews and recommendations
  • automation/ - Automation recipes

• Use clear, concise language
• Include code examples where applicable
• Add images/diagrams to explain complex concepts
• Follow the existing document structure
• Test your changes locally before submitting

The site automatically deploys to GitHub Pages when changes are pushed to the main branch via GitHub Actions.

1. Go to repository Settings → Pages
2. Source: GitHub Actions
3. Custom domain: Add your domain in the CNAME file

1. Update docs/CNAME with your domain
2. Configure DNS records:
   • Type: A → Points to GitHub Pages IPs
   • Type: CNAME → Points to yourusername.github.io
3. Enable "Enforce HTTPS" in repository settings

This project is licensed under the MIT License - see the LICENSE file for details.

• Issues: Report bugs or request features
• Discussions: Share ideas and get help
• Pull Requests: Contribute directly

Questions? Open an issue or start a discussion!

Built with ❤️ by the home automation community