Emacs Jupyter 项目安装与配置指南

1. 项目基础介绍

Emacs Jupyter 是一个开源项目，它为 Emacs 编辑器提供了一种与 Jupyter 内核进行交互的接口。用户可以通过这个接口使用 Emacs 来运行 Jupyter 内核，并支持 REPL (Read-Eval-Print-Loop) 和 org-mode 源代码块两种交互方式。该项目主要使用 Emacs Lisp 编程语言。

2. 项目使用的关键技术和框架

• Emacs Lisp: 用于编写 Emacs 扩展的编程语言。
• ZeroMQ: 一个高性能的消息传递库，用于在 Emacs 和 Jupyter 内核之间传输消息。
• org-mode: Emacs 中的一个模式，支持结构化编辑和格式化文本，本项目利用它来支持源代码块。
• WebSockets: 用于在浏览器和服务器之间实现双向通信的技术。

3. 项目安装和配置的准备工作与详细步骤

准备工作

• 确保你的系统中已经安装了 Emacs 编辑器。
• 确保你的 Emacs 版本支持模块，因为本项目依赖于一些 Emacs 模块。
• 安装项目依赖的 Node.js (用于构建 widget 支持)。

安装步骤

通过 MELPA 安装

1. 将 MELPA 添加到 Emacs 的包档案中：

   (add-to-list 'package-archives
                 '("melpa" . "https://melpa.org/packages/"))
   

2. 刷新包内容以获取最新版本：

   M-x package-refresh-contents RET
   

3. 安装 Jupyter 包：

   M-x package-install RET jupyter RET
   

手动安装

1. 将项目克隆到本地：

   git clone https://github.com/nnicandro/emacs-jupyter.git
   

2. 将项目目录添加到 Emacs 的加载路径：

   (add-to-list 'load-path "/path/to/emacs-jupyter")
   

3. 加载 Jupyter 项目：

   (require 'jupyter)
   

4. 安装项目依赖的其他包，如 markdown-mode、company-mode、emacs-websocket、simple-httpd 和 zmq。

构建 Widget 支持

1. 在项目顶层目录运行以下命令来构建 widget 支持：

   make widgets
   

2. 确保在 Emacs 中连接到 Jupyter 内核后，可以运行创建 widget 的代码。

以上步骤应该能够帮助你成功安装和配置 Emacs Jupyter 项目。如果遇到问题，请参考项目 README 文件中的详细说明。