Citar 安装与配置指南

原创于 2025-04-04 10:11:22 发布 · 953 阅读

CC 4.0 BY-SA版权

Citar 安装与配置指南

citar Emacs package to quickly find and act on bibliographic references, and edit org, markdown, and latex academic documents. 项目地址: https://gitcode.com/gh_mirrors/ci/citar

Citar 是一个为 Emacs 编辑器设计的开源项目，主要用于管理和操作参考文献数据。该项目主要使用 Emacs Lisp 编程语言。

一、项目基础介绍

Citar 提供了一个高度可配置的 completing-read 界面，用于浏览和操作 BibTeX、BibLaTeX 和 CSL JSON 格式的参考文献数据。它还支持 LaTeX、Markdown 和 Org-cite 的编辑。Citar 的主要特点包括：

快速过滤和选择参考文献条目
在 minibuffer 和 org、markdown、LaTeX 缓冲区中提供上下文操作
支持多种参考文献源的无缝缓存
可配置的 API，包括指示器、笔记、主要模式适配器等

二、项目使用的关键技术和框架

Embark：提供上下文访问操作，在 minibuffer 和 at-point（即在文本中的特定位置）通过 citar-embark-mode 小型模式。
Orderless：一种用于完成读取的样式，允许不按顺序进行搜索。
Marginalia：提供注释和 Embark 的候选项分类。

三、项目安装和配置准备工作

在开始安装 Citar 之前，请确保您的系统满足了以下要求：

安装了 Emacs 28 或更高版本
安装了 Git（用于克隆和更新项目）

四、详细安装步骤

1. 克隆项目到本地

打开终端（或命令提示符），然后输入以下命令来克隆 Citar 项目：

git clone https://github.com/emacs-citar/citar.git

2. 安装依赖

Citar 需要一些 Emacs 包来正常工作。你可以使用以下命令安装推荐包：

Vertico：用于完成界面
Orderless：用于完成样式
Embark：用于上下文操作
Marginalia：用于注释

如果你使用的是 Doom Emacs，可以直接启用 biblio 模块和 vertico 完成模块。

对于 MELPA 用户，可以启用以下配置：

(use-package citar
  :custom
  (citar-bibliography '("~/bib/references.bib")))

如果你使用 GUIX，可以通过以下命令安装 emacs-citar 包：

guix package -i emacs-citar

3. 配置 Citar

将以下配置添加到你的 Emacs 配置文件（通常是 ~/.emacs.d/init.el 或 ~/.emacs）中：

(use-package citar
  :custom
  (citar-bibliography '("~/bib/references.bib"))
  :hook
  (LaTeX-mode . citar-capf-setup)
  (org-mode . citar-capf-setup))

(use-package citar-embark
  :after citar embark
  :no-require
  :config
  (citar-embark-mode))

;; 如果你只打算在 Org-Mode 下使用 Citar
(use-package citar
  :no-require
  :custom
  (org-cite-global-bibliography '("~/bib/references.bib"))
  (org-cite-insert-processor 'citar)
  (org-cite-follow-processor 'citar)
  (org-cite-activate-processor 'citar)
  (citar-bibliography org-cite-global-bibliography))