try adding branding to jupyterlite

Author: 777arc

.github/workflows/build-and-deploy.yml

@@ -105,6 +105,7 @@ jobs:
         run: |
           pip install -r requirements-jupyterlite.txt
           jupyter lite build --contents jupyterlite --output-dir _build/jupyterlite
+          python jupyterlite/inject_branding.py _build/jupyterlite
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3.0.1

jupyter-lite.json

@@ -0,0 +1,7 @@
+{
+  "jupyter-lite-schema-version": 0,
+  "jupyter-config-data": {
+    "appName": "PySDR",
+    "faviconUrl": "/_static/myicon.png"
+  }
+}

jupyterlite/inject_branding.py

@@ -0,0 +1,47 @@
+#!/usr/bin/env python3
+"""Inject PySDR branding into a built JupyterLite site.
+
+Run AFTER `jupyter lite build`. JupyterLab 4 / Notebook 7 render the top-left
+logo from JavaScript and offer no user-CSS hook, so we inline a small stylesheet
+(pysdr-brand.css) into every generated app page. It hides the built-in Jupyter
+mark (#jp-NotebookLogo for the Notebook apps, #jp-MainLogo for Lab) and paints
+the PySDR logo from /_static/logo.svg instead.
+
+Usage: python jupyterlite/inject_branding.py [output_dir]
+       (output_dir defaults to _build/jupyterlite)
+
+Exits non-zero if it patches nothing, so CI fails loudly if a JupyterLite
+upgrade changes the build layout out from under us.
+"""
+from __future__ import annotations
+
+import sys
+from pathlib import Path
+
+HERE = Path(__file__).resolve().parent
+MARKER = "pysdr-branding"
+
+
+def main() -> int:
+    out = Path(sys.argv[1] if len(sys.argv) > 1 else "_build/jupyterlite")
+    if not out.is_dir():
+        print(f"[inject_branding] output dir not found: {out}", file=sys.stderr)
+        return 1
+
+    css = (HERE / "pysdr-brand.css").read_text(encoding="utf-8")
+    block = f'<style data-{MARKER}="1">\n{css}\n</style>'
+
+    patched = 0
+    for html in out.rglob("*.html"):
+        text = html.read_text(encoding="utf-8")
+        if MARKER in text or "</head>" not in text:
+            continue
+        html.write_text(text.replace("</head>", block + "\n</head>", 1), encoding="utf-8")
+        patched += 1
+
+    print(f"[inject_branding] patched {patched} page(s) under {out}")
+    return 0 if patched else 1
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

jupyterlite/pysdr-brand.css

@@ -0,0 +1,31 @@
+/* PySDR branding for the self-hosted JupyterLite deployment.
+ *
+ * JupyterLab 4 / Notebook 7 build the top-left logo in JavaScript and expose no
+ * user-CSS hook, so inject_branding.py inlines this file into every generated
+ * app page after `jupyter lite build`. We hide the built-in Jupyter mark and
+ * paint the PySDR logo (served at /_static/logo.svg on the deployed site)
+ * instead. logo.svg is ~1983x1192 (=1.66:1); at 28px tall that is ~47px wide. */
+
+/* Notebook 7 apps: notebooks/, tree/, edit/, consoles/ (this is what opens) */
+#jp-NotebookLogo {
+  background-image: url(/_static/logo.svg);
+  background-repeat: no-repeat;
+  background-position: left center;
+  background-size: contain;
+  width: 48px;
+}
+#jp-NotebookLogo svg {
+  visibility: hidden;
+}
+
+/* JupyterLab app: lab/ */
+#jp-MainLogo {
+  background-image: url(/_static/logo.svg);
+  background-repeat: no-repeat;
+  background-position: center;
+  background-size: contain;
+  width: 48px;
+}
+#jp-MainLogo svg {
+  visibility: hidden;
+}