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.3.0.tar.gz (406.6 kB view details)

Uploaded Source

Built Distribution

jupyter_wysiwyg-23.3.0-py3-none-any.whl (805.9 kB view details)

Uploaded Python 3

File details

Details for the file jupyter_wysiwyg-23.3.0.tar.gz.

File metadata

  • Download URL: jupyter_wysiwyg-23.3.0.tar.gz
  • Upload date:
  • Size: 406.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for jupyter_wysiwyg-23.3.0.tar.gz
Algorithm Hash digest
SHA256 d1a96921b52f90473797833f2fc64148d89b094df89960da6af4715d10dc696f
MD5 d101be16a1a61fce14f829c503c86f42
BLAKE2b-256 5f7cd8eb69b089d8f44b60f54ce2ab574ee341eea3f85774ce585429c23795f6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jupyter_wysiwyg-23.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 08a147a74b78e0756a0bc27250117578d183f820506d2519ab42d2e63dd9126c
MD5 d5ce06c25b76a2efe4a688c092a187b4
BLAKE2b-256 b398fade7b76e5f80c269faecc2ec33736542e0f33c40cabd418ed95aff2455b

See more details on using hashes here.

Supported by

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