Merge branch 'upgrade-mkdocs-material' into 'master'

Upgrade mkdocs-material, fix CI and volume=0

See merge request stream-server/stream-server!2

.gitlab-ci-docs.yml

@@ -6,13 +6,13 @@ docs:
 
   before_script:
     - apt-get update
-    - apt-get install -y --no-install-recommends gcc
+    - apt-get install -y --no-install-recommends gcc git
 
     # TODO: we should consider also version locking these packages:
     #  ++ everything will work in the future
     #  -- we won't see any future improvements of the mkdocs and mkdocs-material packages
     - pip install mkdocs
-    - pip install mkdocs-material
+    - pip install mkdocs-material mkdocs-minify-plugin mkdocs-git-revision-date-localized-plugin
 
     # This is my own extension that we use to insert the $VERSION env variable into the documentation
     - pip install pymdown-env

CHANGELOG.md

 # Changelog
 
+### v0.9.15 <small>_June 16, 2020_</small>
+* Server: Fixed chat
+* Server: Fixed `volume=0` not working
+* CI: Fixed build
+* Docs: Upgraded mkdocs-material
+
 ### v0.9.14 <small>_January 3, 2020_</small>
 * Server: Fixed channelsToIDCache not being initialized
 

docs/about/authors-notes.md

@@ -5,4 +5,3 @@
 * <simon.kirsten@stud.h-da.de>
 * <https://github.com/skirsten>
 * `Simon#2307` on Discord
-* `simon.kirsten@stud.h-da.de` on Slack
\ No newline at end of file

docs/about/contributing.md

@@ -25,16 +25,18 @@ The Stream Server is written in [Go](https://golang.org). It uses [Go Modules](h
 The `cmd/` directory contains only the `stream-server` command. The code of the server is in `internal/server` and the static files for the playback website in `internal/static`.  
 `pkg/` contains project independent code to access the Twitch API. This separation is done in accordance to the [Standard Go Project Layout](https://github.com/golang-standards/project-layout).
 
-Local development (requires go 1.12 and a Twitch client id):
-
-``` bash tab="bash" linenums="1"
-env TWITCH_CLIENT_ID="your client id here" go run ./cmd/stream-server
-```
-
-``` PowerShell tab="PowerShell" linenums="1"
-$env:TWITCH_CLIENT_ID="your client id here"
-go run .\cmd\stream-server
-```
+Local development (requires go 1.13 and a Twitch client id):
+
+=== "bash"
+    ``` bash linenums="1"
+    env TWITCH_CLIENT_ID="your client id here" go run ./cmd/stream-server
+    ```
+
+=== "PowerShell"
+    ``` PowerShell linenums="1"
+    $env:TWITCH_CLIENT_ID="your client id here"
+    go run .\cmd\stream-server
+    ```
 
 CI pipeline: `.gitlab-ci-server.yml`
 

docs/download-and-run.md

@@ -2,7 +2,7 @@
 
 ## Download
 
-Version `~~~${VERSION}~~~`
+Version `~~~${VERSION}~~~` [changelog](about/changelog.md)
 
 OS              | CPU Platform  | Download
 --------------- | ------------- | ----------------------------------------------------------------------

internal/static/main.js

@@ -56,7 +56,10 @@ function updateState(newState) {
   if (state.large_channel != "") {
     function update() {
       // the volume needs to be changed
-      if (large_player.getVolume() != state.volume) {
+      if (state.volume == 0) {
+        large_player.setMuted(true);
+      } else {
+        large_player.setMuted(false);
         large_player.setVolume(state.volume);
       }
 

mkdocs.yml

@@ -12,23 +12,26 @@ repo_url: https://code.fbi.h-da.de/stream-server/stream-server
 
 # Configuration
 theme:
-  name: 'material'
+  name: "material"
   language: en
-  # palette:
-  #   primary: 'blue grey'
-  #   accent: 'light blue grey'
-  feature:
-    tabs: true
+  palette:
+    scheme: slate
+    primary: lime
+    accent: lime
+  icon:
+    repo: fontawesome/brands/gitlab
+  features:
+    - instant
 
 # Plugins
 plugins:
   - search
+  - git-revision-date-localized
   - minify:
       minify_html: true
 
 # Customization
-extra:
-  repo_icon: gitlab
+# extra:
 
 # Extensions
 markdown_extensions:
@@ -57,21 +60,22 @@ markdown_extensions:
   - pymdownx.tasklist:
       custom_checkbox: true
   - pymdownx.tilde
+  - pymdownx.tabbed
   - pymdown_env
 
 # Page tree
 nav:
   - Stream Server:
-    - Project: index.md
-    - Download and Run: download-and-run.md
-    - Options: options.md
-    - Quickstart: quickstart.md
-    - Reference: reference.md
-    - Android Integration: android-integration.md
+      - Project: index.md
+      - Download and Run: download-and-run.md
+      - Options: options.md
+      - Quickstart: quickstart.md
+      - Reference: reference.md
+      - Android Integration: android-integration.md
 
   - About:
-    - Changelog: about/changelog.md
-    - Contributing: about/contributing.md
-    - Author's Notes: about/authors-notes.md
-    - Previous Considerations: about/previous-considerations.md
-    - License: about/license.md
+      - Changelog: about/changelog.md
+      - Contributing: about/contributing.md
+      - Author's Notes: about/authors-notes.md
+      - Previous Considerations: about/previous-considerations.md
+      - License: about/license.md