nbdev VSCode

An experimental nbdev extension for VSCode

Current Features

Note: This extension assumes the workspace's root is the nbdev project's root.

1. Navigate between code in notebooks and python modules with the F2 key. This will navigate to the right cell in the corresponding notebook or the corresponding line in the python module! Demo

2. Autocomplete with hints for important directives. This triggers in notebooks when you type #| (needs a space after the | to trigger the autocomplete). Demo

3. Clean notebooks automatically on save. We have a Jupyter hook that didn't work in VSCode, and this fixes that. Demo. You can toggle this on/off in User settings.

Installation

Install the extension from the marketplace in your IDE:

Change Keyboard Shortcuts

You can change the default keyboard shortcut from F2 for this extension (and any other extension) by modifying your keyboard shortcuts as follows:

1. Open the command palette: CMD + Shift + P
2. Search for Keyboard Shortcuts, select Preferences: Open Keyboard Shortcuts
3. Search for nbdev in the list of shortcuts
4. If you hover over the left-hand side of the table, an edit icon will appear - this will allow you to change the shortcut.