Skip to main content

Jupyterlab extension to export markdown file as pdf, docx and html (with embedded images)

Project description

jupyterlab_export_markdown_extension

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

[!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.

Export Markdown As menu

Features

  • PDF Export - Full Unicode and emoji support via weasyprint
  • DOCX Export - Microsoft Word documents with smart image sizing (fit-to-page for large images)
  • HTML Export - Standalone files with embedded images
  • Mermaid Diagrams - Client-side rendering with calibrated DPI scaling (configurable, default 150 DPI)
  • Embedded Images - Local images automatically converted to base64
  • 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 via JupyterLab 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 weasyprint Unicode, emojis, compact styling
DOCX python-docx + htmldocx Smart image sizing, banded tables, 0.5" margins
HTML markdown Standalone with embedded images

Settings

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

  • Diagram DPI - Resolution for Mermaid diagrams (default: 150, range: 72-600)

Uninstall

pip uninstall jupyterlab_export_markdown_extension

License

BSD 3-Clause License

Project details


Download files

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

Source Distribution

jupyterlab_export_markdown_extension-1.2.15.tar.gz (481.8 kB view details)

Uploaded Source

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_export_markdown_extension-1.2.15.tar.gz.

File metadata

File hashes

Hashes for jupyterlab_export_markdown_extension-1.2.15.tar.gz
Algorithm Hash digest
SHA256 08e6427920e4a1006520707af74a61c7c67c87d66ac63bfb2bd3c5dc0e414bcf
MD5 b8fdbba55ed43a1d799e8aaab4b3ca48
BLAKE2b-256 91acc3a21da643ac9d7833fcbb9c22daa9fa0cf4edd828a16d547345426aef7a

See more details on using hashes here.

File details

Details for the file jupyterlab_export_markdown_extension-1.2.15-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_export_markdown_extension-1.2.15-py3-none-any.whl
Algorithm Hash digest
SHA256 c1013b07d4498f8751ab8498d5a7bec4b7bfa1abb2174a58fc8f2b6bbff88a00
MD5 fb4c29449c39a0143f9cbcb9ad23adba
BLAKE2b-256 1963dce600a0a6333952a61ea1348ded0de94d583a9271edfe8836b1684ca44d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page