Skip to content
master
Switch branches/tags
Code

Latest commit

* Changes for typescript.

* Update running_zigbee2mqtt.md

* Update how-to-switch-to-dev-branch.md

* Update windows.md

* Update virtual_environment.md

* Update running_zigbee2mqtt.md
5d47bd1

Git stats

Files

Permalink
Failed to load latest commit information.

Zigbee2MQTT.io

This repository contains the Zigbee2MQTT documentation.

Generated documentation

Due to the repetitive nature of zigbee devices, lots of documentation is auto-generated from source code or by particular directives for the exposes and notes section. For local development:

npm install
npm run docgen

Running locally

To run locally, execute the following commands:

# Checkout the repository
git clone https://github.com/Koenkk/zigbee2mqtt.io.git
cd zigbee2mqtt.io/docs

# Make sure that you have atleast Ruby 2.1.0 installed, if this fails, install atleast Ruby 2.1.0
ruby --version

# Install bundler
sudo gem install bundler

# Install dependencies
bundle install

# Start local server
bundle exec jekyll serve

You can now find the local instance under: http://127.0.0.1:4000