Skip to main content

Extensible markdown rendering support in markdown

Project description

jupyterlab_markup

pypi-badge binder-badge ci-badge

Additional markdown rendering support in markdown.

This extension is composed of a Python package named jupyterlab_markup for the server extension and a NPM package named @agoose77/jupyterlab-markup for the frontend extension.

Requirements

  • JupyterLab >= 3.0

Install

pip install jupyterlab_markup

Troubleshoot

If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

jupyter server extension list

If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:

jupyter labextension list

Contributing

Development install

Note: You will need NodeJS to build the extension package.

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 below.

# Clone the repo to your local environment
# Change directory to the jupyterlab_markup directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build

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.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

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

Uninstall

pip uninstall jupyterlab_markup

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_markup-2.0.0.tar.gz (527.3 kB view details)

Uploaded Source

Built Distribution

jupyterlab_markup-2.0.0-py3-none-any.whl (1.4 MB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_markup-2.0.0.tar.gz.

File metadata

  • Download URL: jupyterlab_markup-2.0.0.tar.gz
  • Upload date:
  • Size: 527.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for jupyterlab_markup-2.0.0.tar.gz
Algorithm Hash digest
SHA256 58e0e19408881c9fc7e02672a29d0562b665a8f2ba434f90b89d23371a73047c
MD5 0c3e91be127e66840630ef89580c710a
BLAKE2b-256 3a922b06d513104d997fff1354e524f615ba7cc2315569c2bb46bce3c8c076e5

See more details on using hashes here.

Provenance

File details

Details for the file jupyterlab_markup-2.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_markup-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 67be600fbcf368dfa0b6b6c80ee531cde2e5f3c990cd4b6040feb106ad5fdd5e
MD5 ccdd120443b52e635fc0120b84e26140
BLAKE2b-256 4c81ec9a12be2a4d9c640338d0cc0104377e1dd5bf1b6c2a2e85ec8e89072fcb

See more details on using hashes here.

Provenance

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