beginner77-git
diff --git a/‎.editorconfig
+17 b/‎.editorconfig
+17
diff --git a/‎.eslintignore
-2 b/‎.eslintignore
-2
diff --git a/‎.eslintrc.json
-22 b/‎.eslintrc.json
-22
diff --git a/‎.github/workflows/build-deploy.yml
+68 b/‎.github/workflows/build-deploy.yml
+68
diff --git a/‎.github/workflows/ci.yml
-31 b/‎.github/workflows/ci.yml
-31
diff --git a/‎.github/workflows/update-algolia-index.yml
+68 b/‎.github/workflows/update-algolia-index.yml
+68
diff --git a/‎.gitignore
+4-6 b/‎.gitignore
+4-6
diff --git a/‎LICENSE
100755100644 b/‎LICENSE
100755100644
diff --git a/‎README.md
100755100644
+85-34 b/‎README.md
100755100644
+85-34
diff --git a/‎devices-overview/.browserslistrc
-3 b/‎devices-overview/.browserslistrc
-3
diff --git a/‎devices-overview/.eslintrc.js
-18 b/‎devices-overview/.eslintrc.js
-18
diff --git a/‎devices-overview/.gitignore
-23 b/‎devices-overview/.gitignore
-23
@@ -0,0 +1,17 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{*.md, *.pug}]
+trim_trailing_whitespace = false
@@ -0,0 +1,68 @@
+name: Build ⚙ and Deploy 🚀
+on: push
+
+jobs:
+  build_and_deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🚚
+        uses: actions/checkout@v2
+
+      - name: Setup Node.js ⚗
+        uses: actions/[email protected]
+        with:
+          node-version: '16'
+
+      - name: Determine node version №
+        id: node-version
+        run: |
+          echo "::set-output name=version::$(node -v)"
+
+      - name: Restore Cache 📦
+        uses: actions/[email protected]
+        id: cache
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-node-${{ steps.node-version.outputs.version }}-${{ hashFiles('package-lock.json') }}
+
+      - name: Install dependencies 🌐
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: npm ci
+
+#      - name: Set DEVELOP_BRANCH env var
+#        if: github.ref == 'refs/heads/develop'
+#        run: |
+#          echo "DEVELOP_BRANCH=yes" >> $GITHUB_ENV
+
+      - name: Build 🛠
+        run: npm run build
+
+      - name: Run tests 🩺
+        run: npm run test
+
+      - name: Add build.txt 🗓
+        run: |
+          git log --pretty=format:'%h' -n 1 > dist/build.txt
+          echo >> dist/build.txt
+          date +%F_%T >> dist/build.txt
+
+      - name: Deploy 🚀
+        if: github.ref == 'refs/heads/master'
+        uses: JamesIves/[email protected]
+        with:
+          branch: gh-pages # The branch the action should deploy to.
+          folder: dist # The folder the action should deploy.
+          single-commit: true
+          clean: true
+#          clean-exclude: |
+#            develop
+
+#      - name: Deploy to /develop 🚀
+#        if: github.ref == 'refs/heads/develop'
+#        uses: JamesIves/[email protected]
+#        with:
+#          branch: gh-pages
+#          folder: dist
+#          target-folder: develop
+#          single-commit: true
+#          clean: true
@@ -0,0 +1,68 @@
+name: Update Algolia-Search index
+
+# Only trigger, when the build workflow succeeded on branch master
+on:
+  workflow_run:
+    workflows: [ "Build ⚙ and Deploy 🚀" ]
+    branches: [ master ]
+    types: [ completed ]
+
+jobs:
+  update-algolia-index:
+    runs-on: ubuntu-latest
+    steps:
+        # Try to workaround time gap between newly gh-pages deployment is available (cache cleared?)
+      - name: Wait for deployment is published
+        run: |
+          CNT=1
+          echo Waiting for deployment ${GITHUB_SHA:0:7} is published
+          sleep 60
+          while ! curl -sS https://www.zigbee2mqtt.io/build.txt | grep -qF ${GITHUB_SHA:0:7} ; do
+            CNT=$((CNT+1))
+            sleep 1
+            if [ $CNT -gt 300 ]; then
+              >&2 echo "build.txt does not match current commit"
+              >&2 curl -sS https://www.zigbee2mqtt.io/build.txt
+              exit 1
+            fi
+          done
+
+      - name: Create algolia scraper config
+        run: |
+          cat << EOF > algolia.json
+          {
+            "index_name": "zigbee2mqtt.io",
+            "sitemap_urls": ["https://www.zigbee2mqtt.io/sitemap.xml"],
+            "stop_urls": [],
+            "selectors": {
+              "lvl0": {
+                "selector": "header .router-link-active",
+                "global": true,
+                "default_value": "Miscellaneous"
+              },
+              "lvl1": ".theme-default-content h1",
+              "lvl2": ".theme-default-content h2, .device-page h1 + table tbody tr:nth-child(3) td:nth-child(2)",
+              "lvl3": ".theme-default-content h3",
+              "lvl4": ".theme-default-content h4",
+              "lvl5": ".theme-default-content h5",
+              "text": ".theme-default-content p, .theme-default-content li, .theme-default-content code, .theme-default-content td",
+              "lang": {
+                "selector": "/html/@lang",
+                "type": "xpath",
+                "global": true
+              }
+            },
+            "custom_settings": {
+              "attributesForFaceting": ["lang"]
+            }
+          }
+          EOF
+
+      - run: curl -sSL https://www.zigbee2mqtt.io/build.txt
+
+      - name: Update algolia docsearch
+        uses: darrenjennings/algolia-docsearch-action@master
+        with:
+          algolia_application_id: K1BM3QYQ34
+          algolia_api_key: ${{ secrets.ALGOLIA_INDEX_APIKEY }}
+          file: 'algolia.json'
@@ -1,7 +1,5 @@
-node_modules/
-_site/
-.sass-cache/
+node_modules
+.temp
+.cache
+dist
 .idea
-.DS_Store
-.idea/
-docs/.jekyll-metadata
@@ -1,34 +1,85 @@
-# 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:
-
-```bash
-npm install
-npm run docgen
-```
-
-## Running locally
-To run locally, execute the following commands:
-
-```bash
-# Checkout the repository
-git clone https://github.com/Koenkk/zigbee2mqtt.io.git
-cd zigbee2mqtt.io/docs
-
-# Make sure that you have at least Ruby 2.1.0 installed, if this fails, install at least Ruby 2.1.0
-ruby --version
-
-# Install bundler
-sudo gem install bundler
-
-# Install dependencies
-bundle install
-
-# Start local server
-bundle exec jekyll serve --incremental
-```
-
-You can now find the local instance under: http://127.0.0.1:4000
+# Zigbee2MQTT.io
+
+[![Build ⚙ and Deploy 🚀 ](https://github.com/Koenkk/zigbee2mqtt.io/actions/workflows/build-deploy.yml/badge.svg)](https://github.com/Koenkk/zigbee2mqtt.io/actions/workflows/build-deploy.yml)
+
+This repository contains the [Zigbee2MQTT](https://zigbee2mqtt.io) documentation.
+
+It is based on [VuePress v2](https://v2.vuepress.vuejs.org/).
+
+## Architecture
+
+**Directory-Structure:**
+
+* `docgen`: Some scripts to test and generate the Device-Pages.
+* `docs`: The actual documentation.
+* `docs/.vuepress`: Some VuePress enhancements like Stylesheets.
+* `public`: Static assets.
+* `supported-devices-component`: Vue.js component rendering the devices-overview page.
+* `navbar.ts`: Configuration for the top navigation.
+* `sidebar.ts`: Configuration for the sidebars by individual sections (like _Guide_).
+* `vuepress.config.ts`: The [VuePress config file](https://v2.vuepress.vuejs.org/reference/config.html).
+
+## Docgen
+
+The docgen-scripts helps to generate and update the individual device-pages (`/docs/devices/*.md`).
+[zigbee-herdsman-converters](https://github.com/Koenkk/zigbee-herdsman-converters) exposes a list with supported devices which is used for generation. It also updates the Devices-List used by the _Supported-Devices_ overview page.
+
+The `## Notes` section of each page is writte by hand and does not come from `zigbee-herdsman-converters`. This section gets preserved and can be edited.
+
+Docgen is written in Typescript, so you need a recent version of Node.js and NPM.
+
+```bash
+# Install dependencies
+npm ci
+
+# Run docgen
+npm run docgen
+```
+
+### Docgen Tests
+
+Docgen includes some scripts to help testing the page.
+
+* `check-device-images`: Checks for missing device images
+* `check-links`: Checks for broken internal links
+
+**Attention**: `check-links` iterates over the generated VuePress files, so you have to build the page first!
+
+
+## VuePress
+
+```bash
+# Install dependencies
+npm ci
+```
+
+### Building
+
+```bash
+# Run vuepress build
+npm run build
+```
+
+The build-artifact gets written to `dist` directory. 
+
+### Development
+
+```bash
+# Run vuepress in dev mode with hot-reloading
+npm run dev
+```
+
+The `dev`-Mode **excludes** the huge amount device-pages which slows down the build process drastically.
+If you are interested in the device-pages you could include them by using the `npm run dev:devices` npm-run script.  
+
+
+## Docker
+
+You can also just use a docker-image include Node.js.
+
+```bash
+$ docker run --rm -v $PWD:/app -u $UID -ti node:16 bash
+node@87e1438ef553:/$ cd /app
+node@87e1438ef553:/app$ npm ci
+node@87e1438ef553:/app$ npm run dev
+```