通过Emacs整合org和md文件

0、melpa源的配置

这里用到package基本都通过melpa安装,需要在.emacs配置文件中添加melpa的源配置。
如下:

(add-to-list 'package-archives
             '("melpa" . "http://melpa.org/packages/") t)
(require 'use-package)

1、Emacs中编辑markdown

1.1 安装 markdown-mode

接下来,安装和配置markdown-mode可以直接通过如下配置完成:

(use-package markdown-mode
  :ensure t
  :mode ("README\\.md\\'" . gfm-mode)
  :init (setq markdown-command "pandoc -f markdown-blank_before_header+implicit_figures --lua-filter=/xxx/test.lua"))

可以看出,这里配置markdown-command为pandoc,已实现markdown文件的导出和预览等。这里需要说明下pandoc后面的参数:

  • -f markdown-blank_before_header+implicit_figures,这里配置每个标题前面不用带一个空行。如果不加这个配置,如果标题前面没有空行,markdown文件预览和导出的时候就会格式不正常。
  • --lua-filter=/xxx/test.lua,这里配置了一个lua过滤器,用于处理导出和预览的时候,对markdown文件的转换过程做自定义控制。
    这里这个test.lua文件的内容如下:
    function Image (img)
        -- get dimensions
        local width, height = 1000, nil -- implement
        img.attributes.width = width
        img.attributes.height = height
        return img
    end
    
    从这里看出,这里主要是控制markdown文件转换成html之后的img标签的宽高属性的。如果不加这个控制,导出的html中,图片都是原样大小,格式比较难看。

如上配置添加之后,重启emacs就可以生效。

1.2 markdown-mode的基本使用

1.2.1 Emacs中预览markdown文件

安装完成之后,为了实现markdown文件的在emacs中的预览。可以在.emacs中添加如下自定义函数:

(defun cam/preview-markdown ()
  (interactive)
  (let ((filename buffer-file-name))
    (message "Rendering Markdown preview of %s" filename)
    (shell-command-on-region (point-min) (point-max) "pandoc -f gfm" "*Preview Markdown Output*")
    (save-selected-window
      (switch-to-buffer-other-window "*Preview Markdown Output*")
      (let ((document (libxml-parse-html-region (point) (point-max)))
            ;; [1] Create the base URL
            (url (concat "file://" filename)))
        (erase-buffer)
        ;; [2] wrap `document` in a <base> element
        (shr-insert-document `(base ((href . ,url)) ,document))
        (goto-char (point-min))))))

功能上看,这个函数主要的功能是实现了md文件在预览时,可以正确展现和md文件在同一目录,并且引用直接通过相对路径引用的图片。实现的思路,其实也很简单,只不过是将相对路径,改成了绝对路路径。
接下来,可以通过C-x C-f新建一个test.md文件,如下:

# 1、一级标题
一级标题的内容1
## 1.1 二级标题
二级标题的内容1
## 1.2 二级标题
二级标题的内容1
# 2、一级标题
一级标题的内容2
## 2,1二级标题
二级标题的内容2
## 2.2 二级标题
二级标题的内容2

然后,C-x C-s保存后,通过C-x 3,将这个文件水平分隔到两个window中。
执行前面自定义的M-x cam/preview-markdown命令,就可以实现markdown文件在emacs中的预览。预览markdown的buffer名为*Preview Markdown Output*,目前我还没掌握比较方便的emacs窗口移动方式,可以通过前面水平分隔窗口之后,手动选择这个预览的buffer,来实现符合直觉的预览。效果如下图:

image.png

1.2.2 markdown文件的导出

这里,通过配置一个自定义的函数实现markdown文件的预览。
通过执行M-x markdown-export(C-c C-c e)可以将md文件直接导出到同目录下的html后缀的同名文件。
实际上,C-c C-c之后,emacs中会有提示,如下图:

image.png

根据这个提示,按下v,可以直接导入并在浏览器中预览md文件。

2、Emacs中使用org-roam

2.1 orgmode基本使用

假定已经基本了解,暂时略过。

2.2 org-roam安装和基本配置

由于前面已经配置过melpa,这里,可以直接通过执行M-x package-install RET org-roam RET完成安装。
org-roam最基本的配置,只需要包含如下两行:

;; 设置org-roam文件的目录
(setq org-roam-directory "~/org-roam")
(add-hook 'after-init-hook 'org-roam-mode)

2.3 org-roam-ui安装和基本配置

org-roam-uiorg-roamv2版本的前端(之前的org-roamv1版本对应的前端好像是org-roam-server)。通过它可以实现org-roam中各个节点的可视化展现。
同样,借助于melpa,在.emacs中添加如下配置,可以实现org-roam-ui简单的安装和配置。

(use-package org-roam-ui
  :ensure t ;; 自动安装
  :after org-roam
  :custom
  (org-roam-ui-sync-theme t) ;; 同步 Emacs 主题
  (org-roam-ui-follow t) ;; 笔记节点跟随
  (org-roam-ui-update-on-save t))
(use-package vertico ;; 补全界面优化
  :ensure t
  :config
  (vertico-mode))
(use-package orderless ;; 无序搜索
  :ensure t
  :custom
  (completion-styles '(orderless basic))
  (completion-category-defaults nil)
  (completion-category-overrides '((file (styles partial-completion)))))

这里,同时也顺便安装了两个自动补全和搜索的package。

2.4 org-roam基本使用

2.4.1 使用介绍

最基本的,需要知道如下基本命令:

  • org-roam-node-find,通过关键词查找笔记并跳转,若笔记不存在, 则利用
  • org-roam-node-insert,插入一条笔记的链接
  • org-roam-db-sync,启动到org-roam-ui的同步
  • org-roam-ui-mode,启动打开org-roam-ui

2.4.2 使用示例

这里,首先通过org-roam-node-find创建了一个名为编程的node,然后,在其中,通过分别选中篮球养猫两个关键字,执行org-roam-node-insert命令,创建了另外的两个node。如下:

$ cd ~/org-roam/

$ ls
20230605003250-编程.org
20230605003633-篮球运动.org
20230605003727-关于养猫.org

创建完成,执行保存之后,执行org-roam-ui-mode开启org-roam-ui,然后,执行org-roam-db-sync启动到org-roam-ui的同步,完成后,效果如下:

image.png

这里强大的地方在于,在浏览器的前端,可以通过拖动图标进行预览,并且选中某个节点后支持在emacs中联动打开,非常强大。

3、Emacs中使用md-roam

3.1 安装和基本配置

md-roam的安装不支持melpa,这里需要手动下载github的源码(),解压到指定目录后,在.emacs中配置加载。如下:

(add-to-list 'load-path "/xxx/Emacs/emacs-plugin/md-roam-main")
(setq org-roam-file-extensions '("org" "md")) ; enable Org-roam for a markdown extension
(require 'md-roam)
(md-roam-mode 1) ; md-roam-mode must be active before org-roam-db-sync
(setq md-roam-file-extension "md") ; default "md". Specify an extension such as "markdown"
(org-roam-db-autosync-mode 1) ; autosync-mode triggers db-sync. md-roam-mode must be already active
(add-to-list 'org-roam-capture-templates
    '("m" "Markdown" plain "" :target
      (file+head "%<%Y-%m-%dT%H%M%S>_${title}.md" "---\ntitle: ${title}\nid: %<%Y-%m-%dT%H%M%S>\ncategory: \n---\n")
    :unnarrowed t))

添加之后,重启emacs可以生效。

3.2 基本使用

这里,我们通过执行org-roam-capture命令,输入节点名之后,按m选择前面定义的模板,创建了名为金融数码的markdown格式的node,然后,分别通过选中数码养猫之后,通过执行org-roam-node-insert,创建了分别到数码(markdown格式)和关于养猫(org格式)的链接。
由于配置了自动到org-roam-ui的同步,保存之后,就可以看到org格式和markdown格式的文件都被正常展现在一起了。效果如下:

04_MdRoamUIShow.png

注意:

  • 这里md格式的node只能通过capture模板创建,不然默认都是org后缀的格式;
  • md格式的文件,创建之后,可以移动到子目录,只需要重新执行org-roam-db-sync即可。本质上,每个node的id存在文件上,执行org-roam-db-sync的时候,会扫描所有文件,重建db数据。

4、参考资料

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,835评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,598评论 1 295
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,569评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,159评论 0 213
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,533评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,710评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,923评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,674评论 0 203
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,421评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,622评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,115评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,428评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,114评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,097评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,875评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,753评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,649评论 2 271

推荐阅读更多精彩内容