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-22.12.0b1.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-22.12.0b1-py3-none-any.whl (2.6 MB view details)

Uploaded Python 3

File details

Details for the file jupyter-wysiwyg-22.12.0b1.tar.gz.

File metadata

  • Download URL: jupyter-wysiwyg-22.12.0b1.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-22.12.0b1.tar.gz
Algorithm Hash digest
SHA256 d01b54e4401bc582649265650f3f5814a23feee6fa2630438ff32426e1d8e37a
MD5 ff450909dff2096ac3d499f0581c9285
BLAKE2b-256 dbbad0afeca2f5952ea6e5cb0c7fe592424d424b0c93135249b196398635345a

See more details on using hashes here.

File details

Details for the file jupyter_wysiwyg-22.12.0b1-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyter_wysiwyg-22.12.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 f72c5cfd38660a27e7aabcd4fa5cc60b118b50a15bf1509c3b6002f65ee8c53f
MD5 ef2e65a1c8ea881a3fde42c7dd4ecfbf
BLAKE2b-256 9ed232c5cdada6c7f4c752b05b765f4be14b92bc8b191dbb1405b89b3add0fd4

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