JupyterLab-Vim 使用教程

JupyterLab-Vim 使用教程

jupyterlab-vim:neckbeard: Vim notebook cell bindings for JupyterLab项目地址:https://gitcode.com/gh_mirrors/ju/jupyterlab-vim

1. 项目目录结构及介绍

JupyterLab-Vim 的源代码仓库包含了以下关键目录和文件：

• src/ - 扩展的主要实现，包括 TypeScript 源码。
• package.json - 项目的基本信息，依赖和脚本命令。
• install.js - 用于安装扩展的辅助脚本。
• README.md - 项目说明和使用指南。
• .gitignore - Git 忽略规则，指定不需要版本控制的文件。

此项目是为 JupyterLab 添加 Vim 绑定的社区维护版。其核心功能是在 JupyterLab 中提供类似于 Vim 编辑器的键绑定和模式切换（编辑模式和命令模式）。

2. 项目启动文件介绍

JupyterLab 插件没有传统意义上的“启动文件”。相反，它们通过 JupyterLab 的扩展系统加载。当你在 JupyterLab 中安装了 jupyterlab-vim 并重启它时，该扩展自动激活并开始工作。

在 JupyterLab 的设置中，你可以选择文本编辑器的键盘映射来启用 Vim 模式。这通常是通过菜单 Settings > Text Editor Key Map > Vim 来完成的。

3. 项目的配置文件介绍

JupyterLab-Vim 的配置主要通过 JupyterLab 的用户设置 JSON 文件进行。默认情况下，这个文件位于你的 JupyterLab 用户数据目录下，路径可能是：

• 在 macOS 和 Linux 上：~/.jupyter/lab/user-settings/@axlair/jupyterlab_vim/index.json
• 在 Windows 上：%APPDATA%\jupyter\lab\user-settings@\axlair\jupyterlab_vim\index.json

这个文件可能不存在，直到你首次手动更改设置。要查看或修改这些设置，可以在 JupyterLab 的设置界面搜索 @axlair/jupyterlab_vim。

示例配置可能包括启用手动插入模式切换（toggleInsertMode）或自定义特定的 Vim 映射。例如，要在命令模式下将 jj 设置为退出编辑器，可以添加以下内容到设置 JSON 文件：

{
    "toggleInsertMode": true,
    "keyBindings": {
        "jj": {
            "command": "@axlair/jupyterlab_vim:toggle-insert-mode",
            "when": "jupyterlab-extension:@axlair/jupyterlab_vim && !editorHasFocus"
        }
    }
}

请注意，实际可用的配置选项可能会随插件更新而变化，建议参考最新版的官方文档或项目源码中的说明。

在实际操作前，请确保先备份现有设置以防止意外覆盖。如有疑问，查阅项目的 README.md 或向项目贡献者提问可以获得更多信息。

jupyterlab-vim:neckbeard: Vim notebook cell bindings for JupyterLab项目地址:https://gitcode.com/gh_mirrors/ju/jupyterlab-vim