使用 emace org mode 写博客
为了能让 ox-hugo 导出理想的md 文件, 我们需要在org 文件中插入一些 ox-hugo 能识别的注释来指导ox-hugo 的转换行为
示例:
1
2
3
4
5
6
7
|
#+options: \n:t
#+options: author:nil
#+hugo_auto_set_lastmod: t
#+title: xxx
#+hugo_base_dir: ~/hugo_blog
#+hugo_section: post
#+filetags: xx @yy
|
#+options: \n:t
这个强制让ox-hugo 见到\n 就换行, 即org-mode里面看起来是怎样的, 导出成md 就是怎样的, 不然的话以中文结尾的行将不被换行
#+options: author:nil
这个是不导出 author 的意思, 因为我用的主题是even 这个主题很任性, 不支持作者列表, 而ox-hugo 默认会把author 导出成字符串列表,
如 [“Wcq”], 这样在 hugo -D 的时候就会报错, 解决办法就是不使用org 文件里的author, 而使用 config.toml 里配置的author
#+hugo_auto_set_lastmod: t
把org 文件的最后编辑时间导出为文章的最后更新时间
#+title: xxx
xxx 为博客的文章名
#+hugo_base_dir: ~/hugo_blog
为博客的目录
#+hugo_section: post
为博客目录下的文章存放的文件夹, ox-hugo 导出的文件会存在 hugo_base_dir/hugo_section
按照本文的配置就是存放在 ~/hugo_blog/post 下
这个post 要根据你使用的主题来定, 有些主题用的是 posts
这个是文章的 Tags 和 Categories ( 带 @ 的)
snippet
为了文便, 可以写一个 snippet 来快速插入, M-x: +snippets/new
snippet 文件内容如下:
1
2
3
4
5
6
7
8
9
10
11
12
13
|
# -*- mode: snippet -*-
# name: blog
# uuid: blog
# key: blog
# condition: t
# --
#+options: author:nil
#+hugo_auto_set_lastmod: t
#+title: xxx
#+hugo_base_dir: ~/hugo_blog
#+hugo_section: post
#+filetags: xx @yy
|
写完后保存到 ~/.doom.d/snippets/org-mode/ 文件夹下, 名字可以便宜取
snippet 生效后只需要在org 文件中输入 blog 然后按TAB 键就可以直接快速插入了
使用 ox-hugo 把 org 文件导出成 markdown
ox-hugo 的导出选项如上图所示
一般来说按 C-c C-e 进入导出菜单然后再按 H H 即可
使用 hugo -D 把成有md 编译成html 组成的静态网站
进入blog 所在的目录( 根目录 )执行 hugo -D
比如blog 目录为 ~/hugo_blog
1
2
|
cd ~/hugo_blog
hugo -D
|
如果没有博客目录
新建一个:
1
2
|
cd ~/
hugo new site hugo_blog
|
如果忘记了可以使用 hugo new –help 查看帮助
下载主题
hugo 的主题有很多 可以去 https://themes.gohugo.io/ 找一个,
新的博客仓库还没有主题, 需要下载一个主题比如: Even
1
2
3
4
|
cd ~/hugo_blog
git clone https://github.com/olOwOlo/hugo-theme-even themes/even
cp config.toml config.toml.bak
cp themes/even/exampleSite/config.toml .
|
如上命令会下载Even 到themes 目录, 并把Even 的配置文件拷贝为hugo 的配置文件, 只要稍微修改一下 config.toml 就能用了
修改手的confog.toml 如下:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
baseURL = "http://localhost:1313/"
languageCode = "en"
defaultContentLanguage = "en" # en / zh-cn / ... (This field determines which i18n file to use)
title = "Even - A super concise theme for Hugo"
preserveTaxonomyNames = true
enableRobotsTXT = true
enableEmoji = true
theme = "even"
enableGitInfo = false # use git commit log to generate lastmod record # 可根据 Git 中的提交生成最近更新记录。
# Syntax highlighting by Chroma. NOTE: Don't enable `highlightInClient` and `chroma` at the same time!
pygmentsOptions = "linenos=table"
pygmentsCodefences = true
pygmentsUseClasses = true
pygmentsCodefencesGuessSyntax = true
hasCJKLanguage = true # has chinese/japanese/korean ? # 自动检测是否包含 中文\日文\韩文
paginate = 5 # 首页每页显示的文章数
disqusShortname = "" # disqus_shortname
googleAnalytics = "" # UA-XXXXXXXX-X
copyright = "" # default: author.name ↓ # 默认为下面配置的author.name ↓
[author] # essential # 必需
name = "wcq"
[sitemap] # essential # 必需
changefreq = "weekly"
priority = 0.5
filename = "sitemap.xml"
[[menu.main]] # config your menu # 配置目录
name = "Home"
weight = 10
identifier = "home"
url = "/"
[[menu.main]]
name = "Archives"
weight = 20
identifier = "archives"
url = "/post/"
[[menu.main]]
name = "Tags"
weight = 30
identifier = "tags"
url = "/tags/"
[[menu.main]]
name = "Categories"
weight = 40
identifier = "categories"
url = "/categories/"
[params]
version = "4.x" # Used to give a friendly message when you have an incompatible update
debug = false # If true, load `eruda.min.js`. See https://github.com/liriliri/eruda
since = "2017" # Site creation time # 站点建立时间
# use public git repo url to link lastmod git commit, enableGitInfo should be true.
# 指定 git 仓库地址，可以生成指向最近更新的 git commit 的链接，需要将 enableGitInfo 设置成 true.
gitRepo = ""
# site info (optional) # 站点信息（可选，不需要的可以直接注释掉）
logoTitle = "Nothing To Say" # default: the title value # 默认值: 上面设置的title值
keywords = ["Hugo", "theme","even"]
description = "Hugo theme even example site."
# paginate of archives, tags and categories # 归档、标签、分类每页显示的文章数目，建议修改为一个较大的值
archivePaginate = 15
# show 'xx Posts In Total' in archive page ? # 是否在归档页显示文章的总数
showArchiveCount = true
# The date format to use; for a list of valid formats, see https://gohugo.io/functions/format/
dateFormatToUse = "2006-01-02"
# show word count and read time ? # 是否显示字数统计与阅读时间
moreMeta = true
# Syntax highlighting by highlight.js
highlightInClient = false
# 一些全局开关，你也可以在每一篇内容的 front matter 中针对单篇内容关闭或开启某些功能，在 archetypes/default.md 查看更多信息。
# Some global options, you can also close or open something in front matter for a single post, see more information from `archetypes/default.md`.
toc = true # 是否开启目录
autoCollapseToc = false # Auto expand and collapse toc # 目录自动展开/折叠
fancybox = true # see https://github.com/fancyapps/fancybox # 是否启用fancybox（图片可点击）
# mathjax
mathjax = false # see https://www.mathjax.org/ # 是否使用mathjax（数学公式）
mathjaxEnableSingleDollar = false # 是否使用 $...$ 即可進行inline latex渲染
mathjaxEnableAutoNumber = false # 是否使用公式自动编号
mathjaxUseLocalFiles = false # You should install mathjax in `your-site/static/lib/mathjax`
postMetaInFooter = true # contain author, lastMod, markdown link, license # 包含作者，上次修改时间，markdown链接，许可信息
linkToMarkDown = false # Only effective when hugo will output .md files. # 链接到markdown原始文件（仅当允许hugo生成markdown文件时有效）
contentCopyright = '' # e.g. '<a rel="license noopener" href="https://creativecommons.org/licenses/by-nc-nd/4.0/" target="_blank">CC BY-NC-ND 4.0</a>'
changyanAppid = "" # Changyan app id # 畅言
changyanAppkey = "" # Changyan app key
livereUID = "" # LiveRe UID # 来必力
baiduPush = false # baidu push # 百度
baiduAnalytics = "" # Baidu Analytics
baiduVerification = "" # Baidu Verification
googleVerification = "" # Google Verification # 谷歌
# Link custom CSS and JS assets
# (relative to /static/css and /static/js respectively)
customCSS = []
customJS = []
uglyURLs = false # please keep same with uglyurls setting
# Show language selector for multilingual site.
showLanguageSelector = false
[params.publicCDN] # load these files from public cdn # 启用公共CDN，需自行定义
enable = true
jquery = '<script src="https://cdn.jsdelivr.net/npm/jquery@3.2.1/dist/jquery.min.js" integrity="sha256-hwg4gsxgFZhOsEEamdOYGBf13FyQuiTwlAQgxVSNgt4=" crossorigin="anonymous"></script>'
slideout = '<script src="https://cdn.jsdelivr.net/npm/slideout@1.0.1/dist/slideout.min.js" integrity="sha256-t+zJ/g8/KXIJMjSVQdnibt4dlaDxc9zXr/9oNPeWqdg=" crossorigin="anonymous"></script>'
fancyboxJS = '<script src="https://cdn.jsdelivr.net/npm/@fancyapps/fancybox@3.1.20/dist/jquery.fancybox.min.js" integrity="sha256-XVLffZaxoWfGUEbdzuLi7pwaUJv1cecsQJQqGLe7axY=" crossorigin="anonymous"></script>'
fancyboxCSS = '<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@fancyapps/fancybox@3.1.20/dist/jquery.fancybox.min.css" integrity="sha256-7TyXnr2YU040zfSP+rEcz29ggW4j56/ujTPwjMzyqFY=" crossorigin="anonymous">'
timeagoJS = '<script src="https://cdn.jsdelivr.net/npm/timeago.js@3.0.2/dist/timeago.min.js" integrity="sha256-jwCP0NAdCBloaIWTWHmW4i3snUNMHUNO+jr9rYd2iOI=" crossorigin="anonymous"></script>'
timeagoLocalesJS = '<script src="https://cdn.jsdelivr.net/npm/timeago.js@3.0.2/dist/timeago.locales.min.js" integrity="sha256-ZwofwC1Lf/faQCzN7nZtfijVV6hSwxjQMwXL4gn9qU8=" crossorigin="anonymous"></script>'
flowchartDiagramsJS = '<script src="https://cdn.jsdelivr.net/npm/raphael@2.2.7/raphael.min.js" integrity="sha256-67By+NpOtm9ka1R6xpUefeGOY8kWWHHRAKlvaTJ7ONI=" crossorigin="anonymous"></script> <script src="https://cdn.jsdelivr.net/npm/flowchart.js@1.8.0/release/flowchart.min.js" integrity="sha256-zNGWjubXoY6rb5MnmpBNefO0RgoVYfle9p0tvOQM+6k=" crossorigin="anonymous"></script>'
sequenceDiagramsCSS = '<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/bramp/js-sequence-diagrams@2.0.1/dist/sequence-diagram-min.css" integrity="sha384-6QbLKJMz5dS3adWSeINZe74uSydBGFbnzaAYmp+tKyq60S7H2p6V7g1TysM5lAaF" crossorigin="anonymous">'
sequenceDiagramsJS = '<script src="https://cdn.jsdelivr.net/npm/webfontloader@1.6.28/webfontloader.js" integrity="sha256-4O4pS1SH31ZqrSO2A/2QJTVjTPqVe+jnYgOWUVr7EEc=" crossorigin="anonymous"></script> <script src="https://cdn.jsdelivr.net/npm/snapsvg@0.5.1/dist/snap.svg-min.js" integrity="sha256-oI+elz+sIm+jpn8F/qEspKoKveTc5uKeFHNNVexe6d8=" crossorigin="anonymous"></script> <script src="https://cdn.jsdelivr.net/npm/underscore@1.8.3/underscore-min.js" integrity="sha256-obZACiHd7gkOk9iIL/pimWMTJ4W/pBsKu+oZnSeBIek=" crossorigin="anonymous"></script> <script src="https://cdn.jsdelivr.net/gh/bramp/js-sequence-diagrams@2.0.1/dist/sequence-diagram-min.js" integrity="sha384-8748Vn52gHJYJI0XEuPB2QlPVNUkJlJn9tHqKec6J3q2r9l8fvRxrgn/E5ZHV0sP" crossorigin="anonymous"></script>'
# Display a message at the beginning of an article to warn the readers that it's content may be outdated.
# 在文章开头显示提示信息，提醒读者文章内容可能过时。
[params.outdatedInfoWarning]
enable = false
hint = 30 # Display hint if the last modified time is more than these days ago. # 如果文章最后更新于这天数之前，显示提醒
warn = 180 # Display warning if the last modified time is more than these days ago. # 如果文章最后更新于这天数之前，显示警告
[params.gitment] # Gitment is a comment system based on GitHub issues. see https://github.com/imsun/gitment
owner = "" # Your GitHub ID
repo = "" # The repo to store comments
clientId = "" # Your client ID
clientSecret = "" # Your client secret
[params.utterances] # https://utteranc.es/
owner = "" # Your GitHub ID
repo = "" # The repo to store comments
[params.gitalk] # Gitalk is a comment system based on GitHub issues. see https://github.com/gitalk/gitalk
owner = "" # Your GitHub ID
repo = "" # The repo to store comments
clientId = "" # Your client ID
clientSecret = "" # Your client secret
# Valine.
# You can get your appid and appkey from https://leancloud.cn
# more info please open https://valine.js.org
[params.valine]
enable = false
appId = '你的appId'
appKey = '你的appKey'
notify = false # mail notifier , https://github.com/xCss/Valine/wiki
verify = false # Verification code
avatar = 'mm'
placeholder = '说点什么吧...'
visitor = false
[params.flowchartDiagrams]# see https://blog.olowolo.com/example-site/post/js-flowchart-diagrams/
enable = false
options = ""
[params.sequenceDiagrams] # see https://blog.olowolo.com/example-site/post/js-sequence-diagrams/
enable = false
options = "" # default: "{theme: 'simple'}"
[params.busuanzi] # count web traffic by busuanzi # 是否使用不蒜子统计站点访问量
enable = false
siteUV = true
sitePV = true
pagePV = true
[params.reward] # 文章打赏
enable = false
wechat = "/path/to/your/wechat-qr-code.png" # 微信二维码
alipay = "/path/to/your/alipay-qr-code.png" # 支付宝二维码
[params.social] # 社交链接
a-email = "mailto:your@email.com"
b-stack-overflow = "http://localhost:1313"
c-twitter = "http://localhost:1313"
d-facebook = "http://localhost:1313"
e-linkedin = "http://localhost:1313"
f-google = "http://localhost:1313"
g-github = "http://localhost:1313"
h-weibo = "http://localhost:1313"
i-zhihu = "http://localhost:1313"
j-douban = "http://localhost:1313"
k-pocket = "http://localhost:1313"
l-tumblr = "http://localhost:1313"
m-instagram = "http://localhost:1313"
n-gitlab = "http://localhost:1313"
o-bilibili = "http://localhost:1313"
# See https://gohugo.io/about/hugo-and-gdpr/
[privacy]
[privacy.googleAnalytics]
anonymizeIP = true # 12.214.31.144 -> 12.214.31.0
[privacy.youtube]
privacyEnhanced = true
# see https://gohugo.io/getting-started/configuration-markup
[markup]
[markup.tableOfContents]
startLevel = 1
[markup.goldmark.renderer]
unsafe = true
# 将下面这段配置取消注释可以使 hugo 生成 .md 文件
# Uncomment these options to make hugo output .md files.
#[mediaTypes]
# [mediaTypes."text/plain"]
# suffixes = ["md"]
#
#[outputFormats.MarkDown]
# mediaType = "text/plain"
# isPlainText = true
# isHTML = false
#
#[outputs]
# home = ["HTML", "RSS"]
# page = ["HTML", "MarkDown"]
# section = ["HTML", "RSS"]
# taxonomy = ["HTML", "RSS"]
# taxonomyTerm = ["HTML"]
|
手动建md 文件
可选, 我一般是用org 直接导出
1
2
|
cd ~/hugo_blog
hugo new post/test.md
|
这样会新建一个 content/post/test.md 文件
直接编辑 markdown 文件即可
如果需要本地调试
1
2
|
cd ~/hugo_blog
hugo serve -D
|
如果没有报错的话, 然后打开浏览器输入 http://localhost:1313/ 即可实时浏览
使用 rsync 把生成的静态网站同步到服务器的博客文件夹
参考 /p/%E4%BD%BF%E7%94%A8rsync-%E6%88%96%E8%80%85-git-%E5%90%8C%E6%AD%A5%E6%9C%AC%E5%9C%B0%E6%95%B0%E6%8D%AE%E5%88%B0%E6%9C%8D%E5%8A%A1%E5%99%A8/
在Emacs 写一个函数可以把上述所有事情做完
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
|
(defun my/deploy-blog()
" 布置 hugo 生成的静态网站到服务器上 "
(interactive)
(let* ((rsync-ssh "")
(src-dir "~/hugo_blog/")
(src-obj "public")
(dst "wcq@IP:~/my_blog/")
(pre-default-directory default-directory)
(result nil))
(when *is-windows*
(setq rsync-ssh "-e \"/cygdrive/e/work/tools/cwRsync_5.4.1_x86_Free/ssh.exe -i /cygdrive/c/Users/wcq/.ssh/id_rsa\"")
(setq src-dir "E:\\Users\\wcq\\AppData\\Roaming\\SPB_Data\\hugo_blog")
(setq src-obj "public\\"))
;; 把 org 文件转换成 md 文件
(save-excursion
(org-hugo-export-wim-to-md))
(setq default-directory src-dir)
(setq result (shell-command-to-string "hugo"))
(if (string-match-p "Error" result)
(progn
;; 生成静态网站失败
(message "result : %s " result)
(message "hugo -D Failed please run hugo serve -D to debug!")
(setq default-directory pre-default-directory))
;; 增加了 --delete 选项 可以删除远程服务器中多余的文件
(message "run cmd : %s" (format "rsync -av --exclude=\".git/*\" --delete %s %s \"%s\"" rsync-ssh src-obj dst))
(setq result (shell-command-to-string (format "rsync -av --exclude=\".git/*\" --delete %s %s \"%s\"" rsync-ssh src-obj dst)))
(message "%S" result)
(if (string-match-p "error" result)
(message "rsync failed!!!")
(message "rsync finish!!!"))
(setq default-directory pre-default-directory))))
|