garden/content/articles/来把 org-roam 笔记发布出去吧.md

144 lines
7.3 KiB
Markdown
Raw Permalink Normal View History

2023-05-20 13:32:59 +02:00
+++
title = "来把 org-roam 笔记发布出去吧"
author = ["SouthFox"]
date = 2022-08-30T19:10:00+08:00
lastmod = 2022-08-30T20:49:47+08:00
tags = ["article", "publish"]
draft = false
+++
[org-roam]({{< relref "../main/org_roam.md" >}}) 很好,不过笔记积累久了就会产生分享欲,想要在线发布出去……最近摸爬滚打几天终于是弄出来了……
## 方案选择 {#方案选择}
首先先去网上搜索了一遍,发现还是有一些前人踩路的……
- [Neil's Digital Garden](https://commonplace.doubleloop.net/) 这个网页弄得很漂亮,完成度也很高,然后具体一看源代码,通篇 JavaScript ……额,倒不是说 JS 坏话啦,不过我现在没打算在学 JS 的,而且 npm 确实很折磨人。
[How I publish my wiki with org-publish](https://commonplace.doubleloop.net/20200821142536-how_i_publish_my_wiki_with_org_publish) 所使用的代码也确实有点复杂了(我,纯纯菜狐)。
- [My Org Roam Notes Workflow - Hugo Cisneros](https://hugocisneros.com/blog/my-org-roam-notes-workflow/) 这篇文章讲的也不错,不过其博客主题源代码并没有和 org-roam 相关的,好像只有一些框架。好吧,也知道弄 Emacs 相关的作业没那么好抄的,心理准备还是有的。
不过博客讲了如何使用 Python 分析 org-roam 的数据库解析出关系图谱,不过我现在的想法是只把我一部分笔记发布出去,而我又想通过 Drone 这个 CI 平台自动构建网站,所以也用不到了……
- 最后试了试 [jethrokuan/braindump](https://github.com/jethrokuan/braindump) 方案,这个也是 org-mode 作者在用的,所以也算是钦定方案了(
但实际其采用的脚本我无法使用,可能和我用的 Doom Emacs batch 环境有问题吧,也不知道怎么解决(我,究极菜狐)……所以最后只能自己慢慢折腾了!
## 准备 {#准备}
首先要先下载 ox-hugo 包,先把 org-mode 所用的 .org 文件转换成 .md 再给 hugo 解析……没错Emacser 就是这么自由,虽说 hugo 原生就支持 org 文件,不过 Markdown 支持更优秀的话用 Markdown 也不是不行……(反正也是自动转换的)
### 代码 {#代码}
```elisp
(setq org-hugo-base-dir "~/Documents/roam-publish/")
(defun my/org-roam-filter-by-tag (tag-name)
(lambda (node)
(member tag-name (org-roam-node-tags node))))
(defun my/org-roam-list-notes-by-tag (tag-name)
(mapcar #'org-roam-node-file
(seq-filter
(daviwil/org-roam-filter-by-tag tag-name)
(org-roam-node-list))))
(defun my/org-roam-export-all ()
"Re-exports all Org-roam files to Hugo markdown."
(interactive)
(dolist (org-file (my/org-roam-list-notes-by-tag "publish"))
;(dolist (org-file (directory-files-recursively org-roam-directory "\.org$"))
(with-current-buffer (find-file org-file)
(org-hugo-export-wim-to-md))))
(defun my/org-roam-creat-node ()
"creat node and add NODE tag"
(interactive)
(org-id-get-create)
(org-set-tags ":NODE:")
(save-buffer)
(org-hugo-export-wim-to-md))
```
第一行是指定 ox-hugo 生成的博客路径。
第二第三个函数虽然前缀是 my 但其实根本是网上找的……作用是将 org-oroam 笔记中筛选出标签带 "publish" 的笔记,然后挨个用 org-hugo-export-wim-to-md 执行。
最后一个函数就是完全自己写的了,完全没有技术含量,无非就是把一些函数堆叠起来,不过真心好用……[论 Emacs 的易折腾性]({{< relref "../main/论_emacs_的易折腾性.md" >}})。
## 究极折腾 {#究极折腾}
### 路径问题 {#路径问题}
写好函数之后就能把笔记发布并转换为 .md 文件了,但实际上 ox-hugo 不知道是不是我配置问题,出来的链接都带有我 org-mode 设置的文件夹路径,所以得自己清洗一些……
```shell
sed -i 's/..\/main\///' content/posts/*.md
sed -i "s/..\/references\///" content/posts/*.md
sed -i "s/..\article\///" content/posts/*.md
sed -i 's/..\/main\///' content/posts/*.md
sed -i "s/..\/references\///" content/posts/*.md
sed -i "s/..\article\///" content/posts/*.md
sed -i 's/..\/main\///' content/posts/*.md
sed -i "s/..\/references\///" content/posts/*.md
sed -i "s/..\article\///" content/posts/*.md
```
具体而言就是用 Linux 里的 sed 命令将路径删掉,至于为什么要重复三次是因为一次似乎洗不干净我也懒得找具体原因,所以直接暴力重复三次了……
然后 Hugo 默认配置下找不到路径将会直接报错退出,对于 roam 这种经常附个链接又不具体写的情况不友好,搜索下来发现官方文档已经有具体方案了。
[Links and Cross Referencess | Hugo](https://gohugo.io/content-management/cross-references/#ref-and-relref-configuration)
只要在配置文件写入 refLinksErrorLevel = "WARNING" 这行配置就行了,配置成警告而不报错导致中止。
### 搜索问题 {#搜索问题}
主题自带的搜索无法搜索中文,不过相比 Emacs 相关问题Hugo 相关真是好找太多了
然后参考了这个方案 [Hugo JS Searching with Fuse.js · GitHub](https://gist.github.com/eddiewebb/735feb48f50f0ddd65ae5606a1cb41ae) ,评论区下面也有人做了中文优化的 [Hugo JS Searching with Fuse.js · GitHub](https://gist.github.com/onegit20/db426ec7c90c545391168a12ebadbd4e) ,能抄作业就是爽啦!
### 评论问题 {#评论问题}
其实到这里直接 hugo 命令生成静态文件就好了,但趁着折腾劲没过去还得再造会儿~
然后打算为自己这个网站加一个评论区,这次不像我博客那样选用要用 GitHub 的方案了,毕竟 GitHub 对完全没技术背景的人来说挺不友好的,所以打算这次选一个完全不用任何额外条件评论功能。
方案是选择是 [Isso](https://isso-comments.de/) ,一个 Python + Sqlite3 的评论实现,总之安装过程就是直接 docker-compose 拉起来就完事了,不过最后嵌入到网站实际使用发现就有麻烦了,因为这个主题选择采用动态加载方式,第二篇文章会加载到侧面,而这里的评论区是不会加载的……鼓捣了半天终于摸索出一个解决方案……
根据官网文档 [Advanced integration](https://isso-comments.de/docs/guides/advanced-integration/) ,解决方案是加载文档时将原来评论区移除,然后附加到新位置上,然后用
```javascript
window.Isso.init()
window.Isso.fetchComments()
```
重新加载评论框…,然后不要忘了在博客模板文件里配置的时候将 section 设置成
```html
<section id="isso-thread" data-title="{{ .Title }}" data-isso-id="{{ .RelPermalink }}">
```
按路径加载的模式,这样才能确保新评论框加载时没有沿用到旧评论框。
### 反向链接 {#反向链接}
模板自带一个反向链接面板,够是够用的,不过 org-roam-v2 新增了酷炫的任意块链接功能怎么能错过呢?所以鼓捣了一下,用 Python bs4 包解析 hugo 生成的 HTML 文件里的内部链接,然后在计算出反链再塞回到原来的文件里……
具体代码非常稀烂……都是大循环直接搞定的……要是真想借鉴的话我也放在了我的 Gitea 仓库上……
## 结语 {#结语}
总之就是十二分折腾,估计燃尽了我几周的能量吧……