1.2 Installation

Org 已内置在 GNU Emacs 发行版中,通常无需额外安装。大多数用户只需启用 Org 即可开始使用其功能。

若因特殊原因需要在预装版本之外另行安装 Org,可使用 Emacs 包管理器或克隆 Org 的 Git 仓库。我们 强烈建议 仅使用一种安装方式。

在预装版本之上安装 Org 时请注意:Org 稳定版与最近三个 Emacs 稳定版完全兼容,但不支持更早版本的 Emacs。

部分 Org 组件依赖包仓库提供的第三方软件包,Org 仅保证与这些第三方包的最新稳定版兼容。

Using Emacs packaging system

新版 Emacs 内置包管理器,可安装 Elisp 库。你可通过 M-x list-packages 打开 “包菜单(package menu)” 安装 Org,详见 Package Menu

Important: 请在未打开任何 ‘.org’ 文件的 Emacs 会话中执行此操作,即尚未加载任何 Org 内置函数的环境。否则自动加载的 Org 函数会导致安装异常。

为避免与内置 Org 模式冲突,可使用命令行安装(需 Emacs 30 及以上版本):

emacs -Q -batch -eval "(progn (require 'package) (package-initialize) (package-refresh-contents) (package-upgrade 'org))"

该方式可将升级过程与运行中的 Emacs 会话隔离,避免出现版本冲突。

Using Org’s Git repository

可克隆 Org 仓库并按以下步骤安装:

$ cd ~/src/
$ git clone https://https.git.savannah.nongnu.org/git/org-mode.git
$ # 也可使用镜像仓库
$ # git clone https://git.sr.ht/~bzg/org-mode
$ cd org-mode/
$ make autoloads

注意此场景下 ‘make autoloads’ 为必需步骤:它会在 ‘org-version.el’ 中定义 Org 版本,并在 ‘org-loaddefs.el’ 中生成自动加载配置。

请在 Emacs 初始化文件中正确配置加载路径:

(add-to-list 'load-path "~/src/org-mode/lisp")

你还可使用 ‘make’ 编译、 ‘make doc’ 生成文档、 ‘make config’ 创建本地配置、 ‘make install’ 安装 Org。执行 ‘make help’ 可查看完整编译与安装选项。

如需更详细的 Org 构建系统说明,可查阅 Worg 上的 Org Build System 页面。

Installing Org’s contributed packages

Org 仓库曾包含 ‘contrib/’ 目录,用于存放社区贡献的扩展。自 Org 9.5 起,该目录已迁移至独立的 org-contrib 仓库,可作为 package 包从 NonGNU ELPA 单独安装。

Org 仓库外有许多优质扩展包,Worg 网站提供 org-contrib 与外部扩展包 列表,该列表并未完全收录所有相关项目。