Npm docs setup (#834)

* added vuepress to package json
* use vuepress from package json

.github/workflows/build.yml

@@ -28,7 +28,7 @@ jobs:
         uses: actions/setup-node@v1
         with:
           node-version: "14.x"
-      - name: Install vuepress
-        run: npm install -g vuepress
+      - name: Install build dependencies
+        run: npm install
       - name: Build documentation
         run: npm run docs:build

.github/workflows/release.yml

@@ -48,8 +48,8 @@ jobs:
         uses: actions/setup-node@v1
         with:
           node-version: "14.x"
-      - name: Install vuepress
-        run: npm install -g vuepress
+      - name: Install build dependencies
+        run: npm install
       - name: Set version tag from git
         run: sed -i "s/version_tag/${GITHUB_REF#refs/tags/}/g" docs/.vuepress/config.js
       - name: Build documentation

.gitignore

@@ -2,3 +2,4 @@
 .vscode
 *_env.ini
 **/.DS_Store
+node_modules

docs/prerequisites/board.md

@@ -36,7 +36,7 @@ The boards below need hardware [parts](parts.md) and electronic/hardware compete
 |ESP32|X|X|X|X|not tested|X|X|
 |ESP8266|X|X|X|not tested|X|X|X|
 
-::: INFO
+::: tip INFO
 Pilight is only supported on ESP, Arduino UNO handle only 32bits values in our context.
 Setup based on HM10 doesn't support some BLE [devices](devices.md#for-ble-devices).
 :::

docs/prerequisites/devices.md

@@ -39,9 +39,9 @@ OpenMQTTGateway is able to scan all the BLE devices that advertise their data so
 
 Exhaustive list [here](https://compatible.openmqttgateway.com/index.php/devices/ble-devices/)
 
-::: INFO
-(1) Not supported with HM10.
-(2) See https://github.com/atc1441/ATC_MiThermometer
+::: tip INFO
+- (1) Not supported with HM10.
+- (2) See https://github.com/atc1441/ATC_MiThermometer
 :::
 
 ![devices](../img/OpenMQTTGateway_devices_ble.png ':size=250%')

docs/prerequisites/parts.md

@@ -15,6 +15,6 @@ Here is below the main parts reference.
 |SX1276|-|-|-|X|-|
 |A6/A7|-|-|-|-|X|
 
-::: INFO
+::: tip INFO
 There is a wide range of parts available that may be compatible with OpenMQTTGateway, the ones [listed](https://compatible.openmqttgateway.com/index.php/parts/) are the ones tested and for which you can ask for support. Indeed for other parts we may not have it so as to reproduce the issue, or in the worst case they may not be compatible.
 :::

docs/use/actuators.md

@@ -8,7 +8,7 @@ So as to pilot the GPIO use the following commands with [simple receiving](../up
 OFF command:
 `mosquitto_pub -t home/OpenMQTTGateway_MEGA/commands/MQTTtoONOFF/setOFF -m 15`
 
-ON command
+ON command:
 `mosquitto_pub -t home/OpenMQTTGateway_MEGA/commands/MQTTtoONOFF/setON -m 15`
 
 or with [json receiving](../upload/pio.md#api)
@@ -16,7 +16,7 @@ or with [json receiving](../upload/pio.md#api)
 OFF command:
 `mosquitto_pub -t home/OpenMQTTGateway_MEGA/commands/MQTTtoONOFF -m '{"gpio":15,"cmd":0}'`
 
-ON command
+ON command:
 `mosquitto_pub -t home/OpenMQTTGateway_MEGA/commands/MQTTtoONOFF -m '{"gpio":15,"cmd":1}'`
 
 ## FASTLED
@@ -28,7 +28,7 @@ ON command
 2. Start fire animation (Fire2012)
 
 ### Hardware wiring
-Theoreticaly it should be possible to use every free IO pin. But after some tests only pin D2 works at WEMOS D1. Other platforms can work.
+Theoretically it should be possible to use every free IO pin. But after some tests only pin D2 works at WEMOS D1. Other platforms can work.
 The default setting use NEOPIXEL (WS2812B). The simplest wiring is direct connect D2 to data pin of LED stripe and connect VCC/GND to power source. You should also add an capacitor.
 
 ## PWM

docs/use/ble.md

@@ -86,14 +86,14 @@ you can also force a scan to be done by the following command:
 `mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{"interval":0}'`
 
 ::: tip
-With Home Assistant, this command is directly avalaible through MQTT auto discovery as a switch into the HASS OpenMQTTGateway device entities list.
+With Home Assistant, this command is directly available through MQTT auto discovery as a switch into the HASS OpenMQTTGateway device entities list.
 :::
 
 Once the forced scan has completed, the previous scan interval value will be restored. Forcing a scan command trigger also a BLE connect process after the scan (see below).
 
 The default value `TimeBtwRead` is set into config_BT.h or into your .ini file for platformio users.
 
-::: info
+::: tip INFO
 For certain devices like LYWSD03MMC OpenMQTTGateway use a connection (due to the fact that the advertized data are encrypted), this connection mechanism is launched after every `ScanBeforeConnect` per default, you can modify it by following the procedure below.
 :::
 

package.json

@@ -2,5 +2,8 @@
   "scripts": {
     "docs:dev": "vuepress dev docs",
     "docs:build": "vuepress build docs"
+  },
+  "devDependencies": {
+    "vuepress": "^1.7.1"
   }
 }