jupyterlab_export_markdown_extension
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 - Rendered server-side to PNG via Playwright Chromium at the configured SVG export width
- Embedded Images - Local images automatically converted to base64
- Syntax Highlighting - Code blocks with Pygments-powered coloring
- Wide Tables - Tables wider than the page wrap within a fitted column layout instead of running past the margin, in PDF, DOCX and HTML
- Merged Cells -
colspanandrowspanon raw HTML table cells merge in DOCX and PDF - Task Lists -
- [x]/- [ ]render as checkbox glyphs in HTML, DOCX and PDF - Lists and Callouts - two-space nested lists render as lists, every ordered list restarts at 1, and a bordered
<div>draws as a box - a uniform border as a frame in its own line style, an accented one with its bar - in DOCX and PDF - Inline HTML -
<span style="color:...">,font-weight,font-style,text-decoration,<mark>,<del>,<ins>,<kbd>,<font color>,align=and<div>render as written in DOCX and PDF - Symbol Glyphs -
★ ☆ ✓ ✗ ☐ ☒, arrows and box drawing name a font of their own in DOCX, so they look the same in every reader's Word - 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
- Command Line -
jupyterlab-export-markdown-extension convertexports a file to PDF, DOCX and HTML without JupyterLab running - Settings - Configure export font size, SVG export width, math export width, themes, and alert label visibility via Settings Editor
- Pure Python - No pandoc, no LaTeX, no system dependencies
Requirements
- JupyterLab >= 4.6.0
- Python >= 3.12
An SVG image or a Mermaid diagram in a DOCX or PDF export is drawn by Playwright Chromium on the server. Install the browser and its system libraries once (about 270 MB; uses sudo apt-get on Debian/Ubuntu):
jupyterlab-export-markdown-extension install
PDF export reads its fonts from /usr/share/fonts/truetype (DejaVu, Liberation or FreeSans); without them it falls back to Helvetica, which draws Latin-1 text only.
Mermaid diagrams are rendered client-side using JupyterLab's built-in Mermaid support; a DOCX or PDF export then rasterizes them in that Chromium. An export driven through the REST endpoints instead of the UI has no browser to render them, so the server renders those diagrams itself with a bundled copy of Mermaid, in the same Playwright Chromium the SVG rasterizer uses - no network access involved.
A diagram that cannot be rendered never fails the export: its source is kept and the response carries an X-Export-Warnings header describing what happened, as a JSON array of {code, count, diagrams, message}. code is one of chromium-unavailable, bundle-missing, syntax-error, layout-unsupported, render-timeout, skipped, budget-exhausted, rasterize-failed or render-failed; count is how many diagrams the warning covers, diagrams a bounded prefix of their zero-based positions in the document, and message the remedy in full - a caller needs nothing beyond the header. An image that is not embedded - its file does not exist or is outside the server root, or its download failed - is reported under the code image-not-embedded, with images, the first 3 of its paths as written, in place of diagrams; HTML keeps such an image's path, DOCX and PDF show a text placeholder. The header is absent when every diagram rendered and every image was embedded, and is listed in Access-Control-Expose-Headers so a cross-origin caller can read it.
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
- Open a markdown file in JupyterLab
- Use File -> Export Markdown As submenu, or
- Open command palette (Ctrl+Shift+C) and search "Export Markdown"
Command Line
The package installs jupyterlab-export-markdown-extension, which converts a file without JupyterLab running. convert starts a private Jupyter server inside the command and calls the same export endpoints as the menu, so the result matches a UI export made with default settings; the one difference is that Mermaid diagrams render in the server's bundled Mermaid instead of the browser's.
jupyterlab-export-markdown-extension convert report.md --to pdf docx html
jupyterlab-export-markdown-extension check # test that Chromium launches
jupyterlab-export-markdown-extension install # download Chromium and its system libraries
- Each document is written beside the source, or to
-o PATHwhen there is one format; an existing file is overwritten - Images are read only from inside
--root(default: the current directory) - pass a folder that holds the file and every image it links to, such as the repository root; an image that is not embedded is named in a warning on stderr - Your own Jupyter configuration is not read, so a contents root or log level set there does not change the export
--theme,--font-sizeand--alert-labelsset what the settings below set in the UIjupyterlab-export-markdown-extension --helplists the commands, the exit codes and examples;<command> --helpdocuments that command's flags and output
An agent skill for AI coding assistants is in .agents/skills/jupyterlab-export-markdown-extension. pip install also copies it to <sys.prefix>/share/jupyter/agents/skills/jupyterlab-export-markdown-extension, a folder no agent reads. Link it from there, with the Python that runs JupyterLab:
mkdir -p ~/.agents/skills && ln -s "$(python -c 'import sys; print(sys.prefix)')/share/jupyter/agents/skills/jupyterlab-export-markdown-extension" ~/.agents/skills/jupyterlab-export-markdown-extension
From a clone, link it into Claude Code:
ln -s "$PWD/.agents/skills/jupyterlab-export-markdown-extension" ~/.claude/skills/jupyterlab-export-markdown-extension
Export Formats
| Format | Library | Notes |
|---|---|---|
| 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 -> Markdown Export Extension:
- Export Font Size - Base body text size for all three formats:
small(10pt),medium(12pt, default),large(13pt). Every other size - headings, tables, code, captions - is a fixed proportion of it, so the whole document scales together - SVG Export Pixel Width - Target pixel width for SVG images and Mermaid diagrams rasterized server-side in DOCX/PDF (default: 1920, range: 400-4096). Height follows the source aspect ratio
- Math Export Pixel Width (PDF only) - Target pixel width for math expression images in PDF export (default: 800, range: 200-3000). DOCX uses native OMML equations and HTML uses KaTeX, neither affected by this setting
- Show Alert Labels - Display alert type labels (NOTE, TIP, etc.) in exported documents (default: off)
Uninstall
pip uninstall jupyterlab_export_markdown_extension
Contributing
If you would like to contribute to this extension, please refer to the Contributing Guide.
License
BSD 3-Clause License
Metadata
Release files for jupyterlab-export-markdown-extension 1.6.48
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| jupyterlab_export_markdown_extension-1.6.48.tar.gz | 2.7 MB | Without provenance | Details for jupyterlab_export_markdown_extension-1.6.48.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| jupyterlab_export_markdown_extension-1.6.48-py3-none-any.whl | Python 3 | none | any | Details for jupyterlab_export_markdown_extension-1.6.48-py3-none-any.whl |
Total release size: 3.9 MB
Release files / jupyterlab_export_markdown_extension-1.6.48.tar.gz
| Download URL | jupyterlab_export_markdown_extension-1.6.48.tar.gz |
|---|---|
| Size | 2.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7b45f8abeae16006dd58c241ac981a7eb12c27bc09a9b988599b6a4cb62c39a1
|
|
BLAKE2b-256 checksum How to use checksums |
169835ab488addf6127ef7b751a748efb085dd7e637c4999ecf7244c266609ab
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.10
|
Release files / jupyterlab_export_markdown_extension-1.6.48-py3-none-any.whl
| Download URL | jupyterlab_export_markdown_extension-1.6.48-py3-none-any.whl |
|---|---|
| Size | 1.3 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b7ee4d59de046d70ad95f1f991674ab93aee058b2878ac246eb41ef1ecc28ca1
|
|
BLAKE2b-256 checksum How to use checksums |
4ed13fe7cbb31d8a6e1c4f145245a4dea34b0889ddf08fe4ef1b9b2de99595b5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.10
|
Security for jupyterlab-export-markdown-extension 1.6.48
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.