sliveshow 0.1.3__tar.gz

sliveshow-0.1.3/.copier-answers.yml

@@ -0,0 +1,14 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: v4.4.0
+_src_path: https://github.com/jupyterlab/extension-template
+author_email: ltshum6-c@my.cityu.edu.hk
+author_name: ltshum
+has_binder: false
+has_settings: true
+kind: frontend
+labextension_name: dive-custom-slideshow
+project_short_description: JupyterLab extension for animated slideshow.
+python_name: custom_slideshow
+repository: https://github.com/ltshum/fyp-dive-custom-slideshow
+test: true
+

sliveshow-0.1.3/.devcontainer/Dockerfile

@@ -0,0 +1,17 @@
+FROM mcr.microsoft.com/devcontainers/miniconda:0-3
+
+# Copy environment.yml (if found) to a temp location so we update the environment.
+COPY environment.yml /tmp/conda-tmp/
+RUN /opt/conda/bin/conda config --add channels conda-forge \
+    && /opt/conda/bin/conda config --remove channels defaults \
+    && /opt/conda/bin/conda install -y mamba
+RUN umask 0002 && /opt/conda/bin/mamba env update -n base -f /tmp/conda-tmp/environment.yml
+
+# [Optional] Uncomment to install a different version of Python than the default
+# RUN mamba install -y python=3.6 \
+#     && pip install --no-cache-dir pipx \
+#     && pipx reinstall-all
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>

sliveshow-0.1.3/.devcontainer/devcontainer.json

@@ -0,0 +1,33 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/miniconda
+{
+  "name": "Miniconda (Python 3)",
+  "build": {
+    "context": "..",
+    "dockerfile": "Dockerfile"
+  },
+
+  // Features to add to the dev container. More info: https://containers.dev/features.
+  // "features": {},
+
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // "forwardPorts": [],
+
+  // Use 'postCreateCommand' to run commands after the container is created.
+  // "postCreateCommand": "python --version",
+
+  // Configure tool-specific properties.
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "dbaeumer.vscode-eslint",
+        "esbenp.prettier-vscode",
+        "meganrogge.template-string-converter",
+        "ms-python.python"
+      ]
+    }
+  }
+
+  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+  // "remoteUser": "root"
+}

sliveshow-0.1.3/.gitignore

@@ -0,0 +1,129 @@
+*.bundle.*
+lib/
+node_modules/
+*.log
+.eslintcache
+.stylelintcache
+*.egg-info/
+.ipynb_checkpoints
+*.tsbuildinfo
+dive_custom_slideshow/labextension
+# Version file is handled by hatchling
+dive_custom_slideshow/_version.py
+
+# Integration tests
+ui-tests/test-results/
+ui-tests/playwright-report/
+
+# Created by https://www.gitignore.io/api/python
+# Edit at https://www.gitignore.io/?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage/
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# End of https://www.gitignore.io/api/python
+
+# OSX files
+.DS_Store
+
+# Yarn cache
+.yarn/
+
+# VS Code
+.vscode/
+.copier-answer.vscode.yml

sliveshow-0.1.3/.prettierignore

@@ -0,0 +1,6 @@
+node_modules
+**/node_modules
+**/lib
+**/package.json
+!/package.json
+custom_slideshow

sliveshow-0.1.3/.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

sliveshow-0.1.3/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+<!-- <START NEW CHANGELOG ENTRY> -->
+
+<!-- <END NEW CHANGELOG ENTRY> -->
+
+## 0.1.3 - 2026/5/14
+
+- Compile with jupyterlab 4.5.x to make it work with xeus kernel that requires 4.5.x.
+
+## 0.1.2 - 2026/4/22
+
+### Added
+
+- Add class labelling for MathJax expressions (Details: [MathJax html extension](https://docs.mathjax.org/en/latest/input/tex/extensions/html.html))
+
+### Fixed
+
+- Fix SVG reset error when no animation is created
+- Fix error initializing multiple SVG images in the same cell
+
+## 0.1.1 - 2026/3/27
+
+### Fixed
+
+- Fix MathJax selector for "animation" object in SVG animations
+- Fix README.md image links
+
+## 0.1.0 - 2026/3/22
+
+- Initial release

sliveshow-0.1.3/Demo/.gitignore

@@ -0,0 +1,2 @@
+# MyST build outputs
+_build

sliveshow-0.1.3/Demo/animation_demo.ipynb

@@ -0,0 +1,42 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# SVG Animation Demo\n",
+    "\n",
+    "This notebook demonstrates `data-animate` style SVG animation working in a **mystmd jupyterbook**\n",
+    "using the `{svg-animate}` directive from the `svg-animate` plugin.\n",
+    "\n",
+    "The same animation config format used by the Reveal.js `dive-custom-slideshow` extension\n",
+    "works here — the plugin wraps it in a self-contained iframe.\n",
+    "\n",
+    ":::{svg-animate} Circle animation\n",
+    ":height: 320px\n",
+    ":background: white\n",
+    "<svg xmlns='http://www.w3.org/2000/svg' width='300' height='300'>\n",
+    "  <circle id='c1' cx='150' cy='150' r='60' style='fill:steelblue'/>\n",
+    "</svg>\n",
+    "<!--\n",
+    "{\n",
+    "  \"setup\": [{\n",
+    "    \"element\": \"#c1\",\n",
+    "    \"modifier\": \"attr\",\n",
+    "    \"parameters\": [{ \"r\": 100 }],\n",
+    "    \"duration\": 1500,\n",
+    "    \"begin\": 0\n",
+    "  }]\n",
+    "}\n",
+    "-->\n",
+    ":::\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": { "display_name": "Python 3", "language": "python", "name": "python3" },
+  "language_info": { "name": "python", "version": "3.10.0" }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

sliveshow-0.1.3/Demo/myst.yml

@@ -0,0 +1,9 @@
+version: 1
+project:
+  title: dive-custom-slideshow Animation Demo
+  plugins:
+    - svg-animate.mjs
+  toc:
+    - file: animation_demo.ipynb
+site:
+  template: book-theme

sliveshow-0.1.3/Demo/svg-animate.mjs

@@ -0,0 +1,180 @@
+/**
+ * svg-animate.mjs
+ * A standalone mystmd / Jupyter Book 2 plugin for SVG animations.
+ *
+ * Adds a {svg-animate} directive that embeds data-animate style SVG
+ * animations using SVG.js. Works by packaging the animation into a
+ * self-contained data URI iframe — no external files, no mystmd
+ * internal imports, robust against future mystmd updates.
+ *
+ * Usage in a markdown cell or .md file:
+ *
+ *   :::{svg-animate}
+ *   :height: 300px
+ *   <svg xmlns="http://www.w3.org/2000/svg" width="300" height="300">
+ *     <circle id="c1" cx="150" cy="150" r="60" fill="steelblue"/>
+ *   </svg>
+ *   <!--
+ *   {
+ *     "setup": [{
+ *       "element": "#c1",
+ *       "modifier": "attr",
+ *       "parameters": [{ "fill": "tomato", "r": 100 }],
+ *       "duration": 1500,
+ *       "begin": 0
+ *     }]
+ *   }
+ *   -->
+ *   :::
+ *
+ * Register in myst.yml:
+ *   project:
+ *     plugins:
+ *       - svg-animate.mjs
+ */
+
+// Pinned to a specific version for stability.
+// Upgrade intentionally by bumping this string.
+const SVG_JS_CDN = 'https://cdn.jsdelivr.net/npm/@svgdotjs/svg.js@3.1.2/dist/svg.min.js';
+
+/**
+ * Build a fully self-contained HTML page that runs the data-animate animation.
+ * This page is embedded as a data URI inside an iframe, so it is completely
+ * isolated from the parent page's CSS and JS.
+ */
+function buildAnimationPage(svgContent, bgColor) {
+  return `<!DOCTYPE html>
+<html>
+<head>
+<meta charset="utf-8">
+<style>
+  html, body {
+    margin: 0;
+    padding: 0;
+    width: 100%;
+    height: 100%;
+    background: ${bgColor};
+    overflow: hidden;
+    display: flex;
+    align-items: center;
+    justify-content: center;
+  }
+  svg { max-width: 100%; max-height: 100%; }
+</style>
+<script src="${SVG_JS_CDN}"></script>
+</head>
+<body>
+<div data-animate>
+${svgContent}
+</div>
+<script>
+(function () {
+  function tryAnimate() {
+    if (typeof SVG === 'undefined') { setTimeout(tryAnimate, 100); return; }
+    document.querySelectorAll('[data-animate]').forEach(function (el) {
+      var match = el.innerHTML.match(/<!--([\\s\\S]*?)-->/);
+      if (!match) return;
+      var config;
+      try { config = JSON.parse(match[1].trim()); } catch (e) {
+        console.error('svg-animate: invalid JSON config', e);
+        return;
+      }
+      var svgEl = el.querySelector('svg');
+      if (!svgEl) return;
+      var draw = SVG(svgEl);
+      (config.setup || []).forEach(function (step) {
+        var target = draw.findOne(step.element);
+        if (!target) return;
+        var anim = target.animate(step.duration || 1000, step.begin || 0);
+        if (typeof anim[step.modifier] === 'function') {
+          anim[step.modifier](step.parameters[0]);
+        }
+      });
+    });
+  }
+  if (document.readyState === 'loading') {
+    document.addEventListener('DOMContentLoaded', tryAnimate);
+  } else {
+    tryAnimate();
+  }
+})();
+</script>
+</body>
+</html>`;
+}
+
+/**
+ * Encode a unicode string as base64.
+ * Works in Node.js 16+ and modern browsers.
+ */
+function toBase64(str) {
+  const bytes = new TextEncoder().encode(str);
+  let binary = '';
+  bytes.forEach(function (b) { binary += String.fromCharCode(b); });
+  return btoa(binary);
+}
+
+const svgAnimateDirective = {
+  name: 'svg-animate',
+  doc: [
+    'Embed an SVG animation using data-animate syntax (SVG.js).',
+    'The animation runs in a self-contained iframe and works in',
+    'mystmd jupyterbooks, Jupyter Book 2, and static HTML exports.',
+  ].join(' '),
+  alias: ['animate-svg'],
+  arg: {
+    type: String,
+    doc: 'Optional accessible title for the animation frame.',
+  },
+  options: {
+    width: {
+      type: String,
+      doc: 'Width of the animation frame in CSS units (default: 100%).',
+    },
+    height: {
+      type: String,
+      doc: 'Height of the animation frame in CSS units (default: 300px).',
+    },
+    background: {
+      type: String,
+      doc: 'Background colour of the animation frame (default: transparent).',
+    },
+  },
+  body: {
+    type: String,
+    required: true,
+    doc: [
+      'SVG element with animation config. Place the JSON config inside',
+      'an HTML comment (<!-- ... -->) inside or after the SVG, following',
+      'the data-animate convention.',
+    ].join(' '),
+  },
+  run(data) {
+    const svgContent = data.body || '';
+    const width     = (data.options && data.options.width)      || '100%';
+    const height    = (data.options && data.options.height)     || '300px';
+    const bg        = (data.options && data.options.background) || 'transparent';
+    const title     = data.arg || 'SVG Animation';
+
+    const htmlPage = buildAnimationPage(svgContent, bg);
+    const encoded  = toBase64(htmlPage);
+    const src      = 'data:text/html;base64,' + encoded;
+
+    return [{
+      type:   'iframe',
+      src:    src,
+      width:  width,
+      height: height,
+      title:  title,
+    }];
+  },
+};
+
+const plugin = {
+  name:    'SVG Animate',
+  author:  'Alyan Ahmedani',
+  license: 'MIT',
+  directives: [svgAnimateDirective],
+};
+
+export default plugin;

sliveshow-0.1.3/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, ltshum
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.