重要,请认真阅读
-
软件需求
- hugo >= 0.60
- git
-
安装完上述软件后:
git clone [email protected]:njudii/blog.git cd blog/ # 以下称为根目录
(注:这个仓库使用
docs
目录作为GitHub-Pages。) -
在根目录下使用
hugo new post/xxx.md
来新建一个文件(为保证格式统一,请不要把别的md文件直接复制到content/post/
里)。然后编辑content/post/xxx.md
文件。(参考下面的“Hugo的用法”)使用
hugo server
启动本地浏览器预览。编辑完成,预览无误后,运行deploy.sh
即可部署到网页(当然如果你的电脑不是Linux系统,也可以手动执行里面的内容)。 -
如果你不是该repo的唯一编辑者, 每次编辑前要pull!编辑后要push!,即不要造成冲突。
-
目录结构为(有的目录没有,没关系,如果需要可以自己创建):
. ├── README.md ├── config.toml # 博客站点的配置文件,基本不用改 ├── deploy.sh # 部署到GitHub的脚本 ├── archetypes/ # 文章模板 ├── content/ # 博客文章内容 │ ├── about/ # about页面,可以修改 │ ├── archives/ # 用来生成归档,不用修改 │ ├── fig/ # 存放文章插图,插图方式为![](/blog/fig/xxx.png) │ ├── innerlinks/ # 放一些杂物,内链页面等等 │ └── post/ # 博客文章的文件,主要工作就在这 ├── docs/ # GitHub-Pages ├── files/ # 放大文件(~>5M),但是强烈不建议用GitHub放大文件和二进制文件(除了插图和必要的pdf)!能写成文字的尽量写文字 ├── public/ # 不知道什么用 ├── resources/ # 同上 ├── static/ # 官方说用来放大文件,但我没用(我用了上面那个`` files ``) └── themes/ # 放博客主题,主要是~~前端切图仔~~的工作,基本不用改,除非你知道这是什么 └── maupassant/
hugo
和 hexo
一样是个静态博客网页生成软件,优点是轻便。
注: 如果你要全新建立一个博客(不像这里的repo),输入 hugo new site xxx
,然后cd进入你博客的根目录(比如这里的blog/
)。
以下操作都默认在博客根目录执行。
-
修改配置文件
config.toml
中相关部分本站不需要修改。
-
新建一篇文章:
hugo new post/xxx.md
编辑那个xxx.md,写入你想写的内容,保存退出。
-
编辑文章
-
开头
每一篇新建的文章的开头都形如:
+++ title = "标准化考试专题(T/G/I/Sub)" date = 2019-07-19T00:00:00 categories = ["出国"] tags = ["TOEFL", "GRE", "Sub"] postauthor = ["本文作者"] draft = false +++
这被称为
front matter
,(你可以理解为LaTeX里的导言区)。每个条目的作用可以顾名思义。这里建议categories
只写一个,tags
可以根据自己的需求写,但一定不要忘了加引号。 -
中间
<!--more-->
是用来分割文章预览与正文的,写在其之前的文字会出现在首页。可以参考现有的文章。文章的段落标题分级从二级标题##
开始。 -
更多关于md文件的介绍,请查看这里
-
-
选定主题:
到hugo的主题网站选一个你喜欢的主题,并按说明安装。本博客的主题是
maupassant
。本repo已经安装好了,这一步不用操作。
-
本地预览:
hugo server
执行过这条命令后有类似如下的输出:
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1) Press Ctrl+C to stop
在浏览器中打开那个网址就可以看到本地预览效果了。
-
部署到github:
hugo
执行完,根目录下你会有一个
public
文件夹,把里面的东西push到你已经开启GitHub Pages
功能的repo里就可以了。本repo已经设置好了,这一步只要运行
deploy.sh
。