Skip to main content

WYSIWYG editing functionality for markdown/HTML cells in Jupyter

Project description

Rich Text HTML/Markdown Editor for JupyterLab

This is an nbextension that enables WYSIWYG editing functionality for HTML/Markdown cells in Jupyter.

Requirements

  • JupyterLab >= 3.0
  • ipywidgets >= 7.0.0

Installing

This extension can be installed through PIP.

pip install jupyter-wysiwyg

OR

# Clone the jupyter-wysiwyg repository
git clone https://github.com/g2nb/jupyter-wysiwyg.git
cd jupyter-wysiwyg 

# Install the jupyter-wysiwyg JupyterLab prototype
pip install -e .
jupyter labextension develop . --overwrite

Development

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension. To develop, run each of the following commands in a separate terminal.

jlpm run watch
jupyter lab

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm.

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

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

jupyter-wysiwyg-23.2.0.tar.gz (1.3 MB view details)

Uploaded Source

Built Distribution

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

jupyter_wysiwyg-23.2.0-py3-none-any.whl (2.6 MB view details)

Uploaded Python 3

File details

Details for the file jupyter-wysiwyg-23.2.0.tar.gz.

File metadata

  • Download URL: jupyter-wysiwyg-23.2.0.tar.gz
  • Upload date:
  • Size: 1.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.2

File hashes

Hashes for jupyter-wysiwyg-23.2.0.tar.gz
Algorithm Hash digest
SHA256 0a0c4c5d82d3d4d26af300079d79fe07a9baa3f2b8528e9d975ccf561d5249c8
MD5 d80d3cc229932155f3fb0542cb049c98
BLAKE2b-256 b6cdb8973a5b40298e429a3b058cd8ec6fb66edb027eda4c9b5beac8002df3b2

See more details on using hashes here.

File details

Details for the file jupyter_wysiwyg-23.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyter_wysiwyg-23.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5bcab39185888a8264912bc21b5f9fe2c63fd2b6e804f11ac78b7a1b8d4c95d7
MD5 1f6bc90941c9c657882ac5b82476bab1
BLAKE2b-256 e25cca9e671982be22639a5f48d5c29df27d2877b78306f6a88909e903a4a9ee

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