Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jupyterlab/jupyterlab-shortcutui
A JupyterLab extension for managing keyboard shortcuts
https://github.com/jupyterlab/jupyterlab-shortcutui
Last synced: about 1 month ago
JSON representation
A JupyterLab extension for managing keyboard shortcuts
- Host: GitHub
- URL: https://github.com/jupyterlab/jupyterlab-shortcutui
- Owner: jupyterlab
- License: bsd-3-clause
- Archived: true
- Created: 2018-06-18T22:07:19.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-08-08T06:52:04.000Z (over 1 year ago)
- Last Synced: 2024-07-06T04:51:35.180Z (5 months ago)
- Language: TypeScript
- Size: 267 KB
- Stars: 54
- Watchers: 5
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-jupyter-resources - GitHub - 53% open · ⏱️ 17.01.2020): (JupyterLab扩展)
- best-of-jupyter - GitHub - 36% open · ⏱️ 08.08.2023): (JupyterLab Extensions)
README
**This repository has been archived** as this feature is part of JupyterLab core since v3.3.0.
# jupyterlab-shortcutui
[](https://mybinder.org/v2/gh/jupyterlab/jupyterlab-shortcutui/master?urlpath=lab)
A JupyterLab extension for managing keyboard shortcuts
## Prerequisites
- JupyterLab
## Usage
- Open the keyboard shortcuts editor from the _Settings_ or _Help_ menu
- Open the keyboard shortcuts editor from the command palette by searching for
"Keyboard Shortcut Editor"
## Install
```bash
jupyter labextension install @jupyterlab/shortcutui
```
## Development
### Contributing
If you would like to contribute to the project, please read our [contributor documentation](https://github.com/jupyterlab/jupyterlab/blob/master/CONTRIBUTING.md).
JupyterLab follows the official [Jupyter Code of Conduct](https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md).
### Install
Requires node 4+ and npm 4+
```bash
# Clone the repo to your local environment
git clone https://github.com/jupyterlab/jupyterlab-shortcutui.git
cd jupyterlab-shortcutui
# Install dependencies
npm install # or yarn
# Build Typescript source
npm run build # or yarn build
# Link your development version of the extension with JupyterLab
jupyter labextension link .
# Rebuild Typescript source after making changes
npm run build # or yarn build
```
To rebuild both the package and the JupyterLab app:
```bash
npm run build
jupyter lab build
```