Skip to main content

A JupyterLab extension that adds code bookmarks.

Project description

JupyterLab Code Bookmarks

A JupyterLab extension that adds code bookmark functionality, similar to the bookmarks VSCode extension.

Author: Ties de Kok (Personal Page)

Table of contents

Introduction

code_bookmarks_demo_v1

Installation

Note: jupyterlab-code-bookmarks requires JupyterLab 3+

pip install jupyterlab-code-bookmarks

How to use

Basic operations

Setting / Removing a bookmark

You can set or remove a bookmark by right clicking a cell and pressing "Toggle bookmark".
Or by using the keyboard shortcut CTRL + ALT + K.

Note: Bookmarks persist when saving/loading the notebook.

Jumping to bookmark

You can jump to the previous or next bookmark by clicking the jump buttons in the toolbar.
Or by using the keyboard shortcuts:

  • CTRL + ALT + J to jump forward
  • CTRL + ALT + L to jump backward

Configuration options

Changing keyboard shortcuts

You can change the keyboard shortcuts through the JupyterLab keyboard shortcuts settings.

Questions?

If you have questions or experience problems please use the issues tab of this repository.

Known bugs and features in progress

  • Copy and pasting a cell works, however, bookmark styling is not applied until webpage refresh.
  • Jumping to a markdown cells does not always move the cell into view.
  • Enable customization of the cell bookmark color.
  • Make toolbar jump icons take up less space using icons.
  • Add basic tests.

License

MIT - Ties de Kok - 2022

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_code_bookmarks-0.1.5.tar.gz (22.5 kB view hashes)

Uploaded Source

Built Distribution

jupyterlab_code_bookmarks-0.1.5-py3-none-any.whl (16.5 kB view hashes)

Uploaded Python 3

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