Skip to content

README.md

Latest commit

 

History

History
100 lines (69 loc) · 3.25 KB

README.md

File metadata and controls

100 lines (69 loc) · 3.25 KB

Exergy Documentation Website

Documentation Website for Exergy Hashrate Heating Systems.

This repository contains the source files for docs.exergyheat.com — guides for integrating bitcoin miners into your smart home.

What's Inside

  • DIY Guides — Set up and configure bitcoin miner smart home control yourself
  • Integration Docs — Custom smart home applications for Canaan Avalon miners, Ocean mining pool, Datum Server and more
  • Automation Blueprints — Pre-built thermostat control, HVAC integration, time-of-use scheduling and more
  • Dashboard Templates — Copy and paste dashboards to monitor and control heat and sats from home miners
  • Calculators — Interactive tools to evaluate hashrate heating economics and compare costs against traditional fuels

Prerequisites

This site is built with mdBook. You'll need:

  • Rust (to install mdBook)
  • mdBook (cargo install mdbook)

Or install mdBook directly via Homebrew (macOS):

brew install mdbook

Getting Started

Clone the Repository

git clone https://github.com/exergyheat/docs.git
cd docs

Run Locally

Start the development server with live reload:

mdbook serve

Open http://localhost:3000 in your browser. Changes to .md files auto-refresh.

Build for Production

mdbook build

Output is generated in the book/ directory.

Project Structure

.
├── book.toml          # mdBook configuration
├── src/
│   ├── SUMMARY.md     # Navigation structure
│   ├── introduction.md
│   ├── diy/           # DIY guides
│   │   ├── brains/        # Home Assistant setup
│   │   ├── integrations/  # Miner integrations
│   │   ├── blueprints/    # Automation templates
│   │   └── dashboards/    # Dashboard templates
│   ├── calculators/   # Calculator documentation
│   └── reference/     # Reference docs
└── theme/             # Custom styling

Contributing

Contributions welcome! Please:

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request

For bug reports and feature requests, open an issue on GitHub.

Related Repositories

See our Home Assistant Integrations Index repository for a complete list.

External Links