Obsidian.el 安装与配置指南-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00124/article/details/147038935

Obsidian.el 安装与配置指南

obsidian.el Obsidian Notes for Emacs 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian.el

1. 项目基础介绍

obsidian.el 是一个开源项目，它为 Emacs 编辑器提供了一种与 Obsidian 笔记应用交互的方式。通过这个项目，用户可以在 Emacs 中创建、编辑和浏览 Obsidian 笔记，同时保留 Emacs 强大的编辑功能。该项目主要使用 Emacs Lisp 编程语言。

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

Emacs Lisp (Elisp)：这是 Emacs 的内置编程语言，用于编写扩展和配置 Emacs。
Obsidian 笔记格式：项目支持 Obsidian 的 Markdown 格式，允许用户在 Emacs 中直接编辑笔记。
文件系统交互：obsidian.el 通过与文件系统的交互来同步和更新 Emacs 中的笔记内容。

3. 项目安装和配置的准备工作

在开始安装前，请确保您的系统中已经安装了以下软件：

Emacs：建议使用最新版本的 Emacs。
Git：用于克隆或拉取项目代码。

详细安装步骤

步骤 1：安装 Emacs

如果您还没有安装 Emacs，请根据您的操作系统说明进行安装。通常，您可以从官方网站 emacs.org 下载，或者使用包管理器进行安装。

步骤 2：安装 Git

如果您还没有安装 Git，请根据您的操作系统说明进行安装。通常，您可以使用包管理器（如 apt、brew 等）进行安装。

步骤 3：克隆项目代码

打开终端或命令提示符，使用以下命令克隆项目代码：

git clone https://github.com/licht1stein/obsidian.el.git

步骤 4：配置 Emacs

在 Emacs 中，您需要配置一些设置来使用 obsidian.el。

打开 Emacs。
按下 M-x（Alt+x），输入 package-list-packages 并按下回车，这将打开包管理器。
在包管理器中，搜索 obsidian.el 并安装它。
安装完成后，关闭包管理器。

步骤 5：配置 `obsidian.el`

在您的 Emacs 配置文件（通常是 ~/.emacs 或 ~/.emacs.d/init.el）中，添加以下代码来配置 obsidian.el：

(require 'obsidian)

; 设置 Obsidian 笔记库的位置
(setopt obsidian-directory "~/path/to/your/obsidian/vault")

; 设置新笔记的默认存储位置
(setopt obsidian-inbox-directory "~/path/to/your/obsidian/inbox")

; 启用 Obsidian 模式和 backlinks 模式
(global-obsidian-mode t)
(obsidian-backlinks-mode t)

请将 ~/path/to/your/obsidian/vault 和 ~/path/to/your/obsidian/inbox 替换为您的实际路径。