https://github.com/mycontroller-org/documentation

MyController 2.x website and documentation
https://github.com/mycontroller-org/documentation

automation controller docsy home-automation hugo internet-of-things iot mycontroller mysensors philips-hue raspberry-pi tasmota

Last synced: about 1 month ago
JSON representation

MyController 2.x website and documentation

• Host: GitHub
• URL: https://github.com/mycontroller-org/documentation
• Owner: mycontroller-org
• License: apache-2.0
• Created: 2021-05-04T06:52:05.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-06-20T13:02:21.000Z (over 1 year ago)
• Last Synced: 2024-11-07T10:48:13.110Z (3 months ago)
• Topics: automation, controller, docsy, home-automation, hugo, internet-of-things, iot, mycontroller, mysensors, philips-hue, raspberry-pi, tasmota
• Language: HTML
• Homepage: https://mycontroller.org
• Size: 3.5 MB
• Stars: 0
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MyController documentation and website

![publish container images](https://github.com/mycontroller-org/documentation/actions/workflows/publish_container_images.yaml/badge.svg)

This repository contains MyController live [website and documentation](https://v2.mycontroller.org). Live always hosts master branch.


You can host it privately on your environment. If you are looking for a specific version.


## Live

* https://v2.mycontroller.org

## Download

### Container images

  * [Docker Hub](https://hub.docker.com/u/mycontroller)

  * [Quay.io](https://quay.io/organization/mycontroller)

`master` branch images are tagged as `:2.x.x-devel`


## Setup development environment

### Pre Requests

* [HUGO](https://gohugo.io/) - Install with extended support

### Setup

```

# update docsy theme dependency

git submodule update --init --recursive

# download npm dependencies

yarn install

# run

hugo serve -D

```

You can see a message,

```

Web Server is available at //localhost:1313/ (bind address 127.0.0.1)

```

On your browser you can access it on the specified address.


Your changes will be updated dynamically.