Skip to main content

jupyterlab_advanced_markdown_viewer_extension

GitHub Actions npm version PyPI version Total PyPI downloads JupyterLab 4 Brought To You By KOLOMOLO Donate PayPal

Keep open Markdown files live. When an AI agentic tool or any other process rewrites a Markdown file on disk, the open rendered view picks up the change on its own: the tab title signals it, removed text is struck on a pale red background, added text stands on a pale green background, and both fade. No more reloading the tab to see the latest content.

Full disclosure: the rest of your JupyterLab stays exactly as it was. This extension only makes sure that the Markdown file you are looking at is the one that is actually on disk.

Features

  • Live updates - open Markdown documents refresh automatically when the file changes on disk
  • Tab title cue - the document tab signals that new content arrived
  • Change highlighting - removed text on a pale red background, added text on a pale green background, both fading out calmly
  • Changes play out as typing - added text appears letter by letter, very fast, on its green background, in every changed place at once; removed text first turns red, then is deleted from its last letter backwards. The reader follows a change as it happens and no text disappears without warning. The animation setting turns this off; animationSpeed sets the speed in characters per second
  • Rendered view - live updates apply to the rendered Markdown view; an editor open on the same file keeps JupyterLab's own File Changed dialog for a save over unsaved edits
  • Unsaved edits are never overwritten - a change arriving while the document has unsaved edits is held, shown as a red tab marker, and applied once the document is clean again

Typing animation: added text grows on green, removed text stands red and is deleted backwards

Tab cue: a green dot before the label and a pulsing icon while changes arrive

Settings

All settings live under Settings, Advanced Settings Editor, Advanced Markdown Viewer.

  • enabled - on by default; off, the preview keeps what it showed until the document is reloaded and nothing else in this extension runs
  • pollInterval - how often an open preview checks its file, in seconds
  • highlight - green and red backgrounds on changed text
  • fadeDuration - how long the highlight takes to fade, in milliseconds
  • animation - on by default; changes play out as typing
  • animationSpeed - typing and deletion speed in characters per second; 0 shows a change at once
  • tabCue - the dot on the document tab

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyterlab_advanced_markdown_viewer_extension

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_advanced_markdown_viewer_extension

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file jupyterlab_advanced_markdown_viewer_extension-0.6.10.tar.gz.

File metadata

File hashes

Hashes for jupyterlab_advanced_markdown_viewer_extension-0.6.10.tar.gz
Algorithm Hash digest
SHA256 c2e47a8b14c4fea9fd86191a93c987585c4b6feb8e0469014e6e41a725af86fa
MD5 1b20aeddc635c3344992b8a1d762f404
BLAKE2b-256 2cd2a43bc42f4489b357d19858a833f5c83b0a1bad3a8f8fd627a1ed6fbe3759

See more details on using hashes here.

File details

Details for the file jupyterlab_advanced_markdown_viewer_extension-0.6.10-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_advanced_markdown_viewer_extension-0.6.10-py3-none-any.whl
Algorithm Hash digest
SHA256 929c33b101f3c21e41b7beadd34ea2967f83a092f96e8443b78ecc7d35d8af91
MD5 bb04c1db4e2ae2087ccc8b12a8dd8dcd
BLAKE2b-256 0e4dbc34739b8b0aa890a67b54c085c1606d0aabd57446f9d4c65ab0c3a3d9c2

See more details on using hashes here.

Release history Release notifications | RSS feed

1.0.12

2 files

1.0.11

2 files

1.0.10

2 files

1.0.9

2 files

1.0.8

2 files

1.0.7

2 files

1.0.5

2 files

1.0.4

2 files

1.0.3

2 files

0.6.41

2 files

0.6.28

2 files

This release

0.6.10 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page