Merge pull request #276 from joBr99/docs

testing mkdocs

.github/workflows/docs.yml

@@ -0,0 +1,16 @@
+name: ci 
+
+on:
+  push:
+    branches: 
+      - main
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material mkdocs-video markdown-include
+      - run: mkdocs gh-deploy --force

docs/faq.md

@@ -0,0 +1,33 @@
+# FAQ - Frequently Asked Questions
+
+## Waiting for content - This is taking longer than usual on the screen
+
+Please check your MQTT Topics in your apps.yaml and your mqtt configuration on tasmota.
+
+## How to upgrade from a release to the current development version
+
+1. Update App in HACS to main
+
+Click redownload in the menu of the app in HACS.
+
+Select main version.
+
+**!!! Wait for it to load, dropdown needs to be selectable again, otherwise it will download the latest release !!!**
+
+![hacs-main](doc-pics/hacs-main.png)
+
+**!!! Wait for it to load, dropdown needs to be selectable again, otherwise it will download the latest release !!!**
+
+Click download.
+
+2. Restart AppDaemon
+
+3. Flash current Development Firmware in Tasmota Console. DO NOT USE THIS URL (only if you are on main/dev)
+
+`FlashNextion http://nspanel.pky.eu/lui.tft`  DO NOT USE THIS URL (only if you are on main/dev)
+
+Development happens in the EU version, so it is possible that the US Version isn't up to date with the current development version of the EU firmware, the lastet US versions are still downloadable with the following links:
+
+`FlashNextion http://nspanel.pky.eu/lui-us-l.tft`  DO NOT USE THIS URL (only if you are on main/dev)
+
+`FlashNextion http://nspanel.pky.eu/lui-us-p.tft`  DO NOT USE THIS URL (only if you are on main/dev)

docs/first_steps.md

@@ -0,0 +1 @@
+# First steps

mkdocs.yml

@@ -0,0 +1,64 @@
+# https://squidfunk.github.io/mkdocs-material/getting-started
+# https://squidfunk.github.io/mkdocs-material/reference/admonitions
+# https://github.com/squidfunk/mkdocs-material/blob/master/mkdocs.yml
+
+
+site_name: NsPanel Lovelace UI Docs
+site_description: Custom Firmware for NsPanel with the design of HomeAssistant's lovelace UI in mind, works with Tasmota.
+site_author: Johannes Braun
+site_url: https://jobr99.github.io/nspanel-lovelace-ui
+
+repo_name: pikvm/pikvm
+repo_url: https://github.com/jobr99/nspanel-lovelace-ui
+edit_uri: ""
+
+copyright: "Copyright © 2022 Johannes Braun"
+
+docs_dir: docs
+
+theme:
+    #logo: _assets/logo.png
+    #favicon: _assets/favicon.ico
+    name: material
+    palette:
+        accent: blue
+    font:
+        text: "arial, sans-serif"
+        code: monospace
+    features:
+        - navigation.indexes
+        - navigation.sections
+        - navigation.top
+        - navigation.tracking
+        - navigation.expand
+        - search.highlight
+        - search.share
+        - search.suggest
+
+extra_css:
+    - _assets/user.css
+
+markdown_extensions:
+    - admonition
+    - def_list
+    - attr_list
+    - pymdownx.tilde
+    - pymdownx.details
+    - pymdownx.superfences
+    - pymdownx.magiclink
+    - toc:
+        permalink: true
+    - codehilite:
+        guess_lang: false
+    - markdown_include.include:
+        base_path: docs
+
+plugins:
+    - search:
+        lang: en
+    - mkdocs-video
+
+nav:
+    - "Getting started":
+        - "First steps": first_steps.md
+        - "FAQ": faq.md