Obsidian.el 使用教程

Obsidian.el 使用教程

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

1. 项目介绍

Obsidian.el 是一个为 Emacs 编辑器开发的插件，它允许用户在 Emacs 中直接操作 Obsidian 的笔记。通过该插件，用户可以在 Emacs 中创建、编辑、搜索和链接笔记，同时享受 Emacs 强大的编辑功能。Obsidian.el 不仅支持在桌面环境中使用，而且由于其与 Obsidian 的同步特性，也适用于移动端。

2. 项目快速启动

安装

首先，确保你的 Emacs 环境已经设置好 MELPA 或 MELPA Stable 源。

在 Emacs 中执行以下命令安装 obsidian.el 插件：

M-x package-install RET obsidian RET

配置

安装完成后，需要在你的 init.el 文件中配置一些基本设置：

(require 'obsidian)

; 设置 Obsidian 文件夹的路径
(setopt obsidian-directory "~/MY_OBSIDIAN_FOLDER")

; 设置新笔记默认存放的文件夹
(setopt obsidian-inbox-directory "Inbox")

; 启用 wiki 链接
(setopt markdown-enable-wiki-links t)

; 绑定快捷键
(define-key obsidian-mode-map (kbd "C-c C-n") 'obsidian-capture)
(define-key obsidian-mode-map (kbd "C-c C-l") 'obsidian-insert-link)
(define-key obsidian-mode-map (kbd "C-c C-o") 'obsidian-follow-link-at-point)
(define-key obsidian-mode-map (kbd "C-c C-p") 'obsidian-jump)
(define-key obsidian-mode-map (kbd "C-c C-b") 'obsidian-backlink-jump)

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

使用

启动 Emacs 并打开一个 Obsidian 笔记文件，你将看到 obsidian.el 的功能已经生效。

3. 应用案例和最佳实践

创建新笔记

使用 obsidian-capture 命令创建新笔记：

M-x obsidian-capture RET

新笔记将默认创建在 Inbox 文件夹中，除非你指定了其他位置。

插入链接

使用 obsidian-insert-link 或 obsidian-insert-wikilink 插入笔记链接：

M-x obsidian-insert-link RET

或者使用快捷键 C-c C-l。

跳转笔记

使用 obsidian-jump 命令跳转到另一个笔记：

M-x obsidian-jump RET

或者使用快捷键 C-c C-p。

查看背链接

使用 obsidian-backlink-jump 命令查看当前笔记的背链接：

M-x obsidian-backlink-jump RET

或者使用快捷键 C-c C-b。

4. 典型生态项目

目前，Obsidian 社区中有许多扩展和插件，例如：

• Obsidian Sync：同步你的笔记到不同的设备。
• Obsidian Graph View：以图形方式展示笔记之间的链接。
• Obsidian Mobile：Obsidian 的官方移动应用。

这些项目可以与 obsidian.el 协同工作，提供更丰富的使用体验。

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