jupyterlab_export_markdown_extension

[!TIP] This extension is part of the stellars_jupyterlab_extensions metapackage. Install all Stellars extensions at once: pip install stellars_jupyterlab_extensions

Export markdown files to PDF, DOCX, and HTML directly from JupyterLab. No external dependencies required - just pip install and go.

Features

• PDF Export - Full Unicode and emoji support via reportlab
• DOCX Export - Microsoft Word documents with smart image sizing (fit-to-page for large images)
• HTML Export - Standalone files with embedded images
• LaTeX Math - Native OMML equations in DOCX (editable in Word), KaTeX in HTML, PNG images in PDF
• GitHub Alerts - Colored alert boxes for [!NOTE], [!TIP], [!IMPORTANT], [!WARNING], [!CAUTION] with left border and background shading in DOCX/PDF
• Mermaid Diagrams - Client-side rendering with calibrated DPI scaling (configurable, default 150 DPI)
• Embedded Images - Local images automatically converted to base64
• Syntax Highlighting - Code blocks with Pygments-powered coloring
• Export Spinner - Modal dialog shows progress during export operations
• File Menu Integration - "Export Markdown As" submenu appears when markdown is active
• Command Palette - All export commands available via Ctrl+Shift+C
• Settings - Configure diagram DPI, math DPI, and alert label visibility via Settings Editor
• Pure Python - No pandoc, no LaTeX, no system dependencies

Requirements

• JupyterLab >= 4.0.0
• Python >= 3.9

For PDF export, install required system libraries and emoji font:

# Ubuntu/Debian
sudo apt-get install libcairo2 libpango-1.0-0 libpangoft2-1.0-0 fonts-noto-color-emoji

Mermaid diagrams are rendered client-side using JupyterLab's built-in Mermaid support - no additional installation required.

Install

pip install jupyterlab_export_markdown_extension

That's it. No really, that's actually it. We spent considerable effort making sure you don't have to install pandoc, LaTeX, or sacrifice a goat to get this working.

Usage

1. Open a markdown file in JupyterLab
2. Use File -> Export Markdown As submenu, or
3. Open command palette (Ctrl+Shift+C) and search "Export Markdown"

Export Formats

| Format | Library | Notes | | ------ | ---------------------- | ------------------------------------------------------------------------ | | PDF | reportlab | Unicode support, compact styling, math as PNG images | | DOCX | python-docx + htmldocx | Native OMML math, smart image sizing, banded tables, alert boxes | | HTML | markdown + KaTeX | Standalone with embedded images, client-side math rendering |

Settings

Configure the extension via Settings -> Settings Editor -> Export Markdown Extension:

• Diagram DPI - Resolution for Mermaid diagrams (default: 150, range: 72-600)
• Math DPI - Resolution for math images in PDF export (default: 200, range: 96-600). DOCX uses native OMML equations instead
• Show Alert Labels - Display alert type labels (NOTE, TIP, etc.) in exported documents (default: off)

Uninstall

pip uninstall jupyterlab_export_markdown_extension

License

BSD 3-Clause License