如何搭建gitee pages

开通gitee pages功能

参照码云Pages开通指南即可完成gitee pages的开通,本文以我的gitee pages地址http://focksor.gitee.io/作为示例。

安装hugo

以windows为例,从Hugo Releases下载对应版本的hugo压缩包,解压之后将里面的hugo.exe复制到环境变量PATH中任意目录下,或者在PATH中添加hugo.exe所在的路径后,打开cmd,执行hugo version,如果显示hugo的版本号,则已完成hugo的安装。

创建新站点

假设要创建的站点存放位置为./path/website/:

C:\Users\focks>hugo new site path/website
Congratulations! Your new Hugo site is created in C:\Users\focks\path\website.

Just a few more steps and you're ready to go:

1. Download a theme into the same-named folder.
   Choose a theme from https://themes.gohugo.io/ or
   create your own with the "hugo new theme <THEMENAME>" command.
2. Perhaps you want to add some content. You can add single files
   with "hugo new <SECTIONNAME>\<FILENAME>.<FORMAT>".
3. Start the built-in live server via "hugo server".

Visit https://gohugo.io/ for quickstart guide and full documentation.

​ 创建完成后进入目录可看到目录结构:

PS C:\Users\focks> cd .\path\website\
PS C:\Users\focks\path\website> ls


    目录: C:\Users\focks\path\website


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
d-----         2020/3/1     17:55                archetypes
d-----         2020/3/1     17:55                content
d-----         2020/3/1     17:55                data
d-----         2020/3/1     17:55                layouts
d-----         2020/3/1     17:55                static
d-----         2020/3/1     17:55                themes
-a----         2020/3/1     17:55             82 config.toml

其中,config.toml是网站的配置文件,content 目录放 markdown 文章,data 目录放数据,layouts 目录放网站模板文件,static 目录放图片等静态资源,themes 命令放下载的主题。

创建第一篇文章

PS C:\Users\focks\path\website> hugo new post/first.md
C:\Users\focks\path\website\content\post\first.md created

此命令会在content目录下创建文件夹post并在post内新建first.md,这个位置与发布时的url有关,如放在如上所说路径下的.md文件生成网页的访问地址是http://focksor.gitee.io/post/first.md。如果你已有用markdown编写的文章,直接将.md·文件复制到content目录内即可,但是要注意,使用该命令创建的.md文件默认包含以下内容文章标题文章创建时间是否为草稿,启动,如果draft: true表示该文章为草稿,在编译的时候会自动略过,发布的站点内也不会有这篇文章。你原有的.md文件也要加上以下内容以便hugo识别。

title: "First"
date: 2020-03-01T18:06:24+08:00
draft: true

安装主题

hugo默认没有安装主题,如果要将你的文章显示,需要先安装主题以确定显示的形式。在没有安装主题之前,hugo是无法正常工作的。

访问hugo主题网站,选择你喜欢的主题并获取该主题的github地址,假设选择的是Angel's Ladder这款主题,进入themes文件夹并将该主题的仓库克隆到本地。如果该主题没有使用git发布或者是你只有它的压缩包,可以加压到themes文件夹也是一样的效果。

cd themes
git clone https://github.com/tanksuzuki/angels-ladder

完成后,themes文件夹内应有如下内容,其中,文件夹名称angels-ladder即为主题名字:

PS C:\Users\focks\path\website\themes> ls


    目录: C:\Users\focks\path\website\themes


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
d-----         2020/3/1     18:25                angels-ladder

修改配置文件config.toml,指定主题为angels-ladder,修改完成后的配置文件如下:

baseURL = "http://example.org/"
languageCode = "en-us"
title = "My New Hugo Site"
theme = "angels-ladder"

同时,你也可以修改config.toml内的title以修改你站点的标题。

启动hugo服务器以预览站点

在发布之前,可以先使用hugo启动本地服务器以查看站点的显示是否与你预期相同:

PS C:\Users\focks\path\website> hugo server -D
Building sites …
                   | EN
-------------------+-----
  Pages            |  9
  Paginator pages  |  0
  Non-page files   |  0
  Static files     |  8
  Processed images |  0
  Aliases          |  1
  Sitemaps         |  1
  Cleaned          |  0

Built in 39 ms
Watching for changes in C:\Users\focks\path\website\{archetypes,content,data,layouts,static,themes}
Watching for config changes in C:\Users\focks\path\website\config.toml
Environment: "development"
Serving pages from memory
Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop

-D表示草稿也会一起编译显示,如果不想编译草稿文档可直接用hugo server启动本地服务器。按照输出信息,hugo本地服务器已启动在http://localhost:1313/,访问该地址即可看到你的站点渲染结果。

编译站点

在编译站点之前,要先将config.toml内的baseURL = "http://example.org/"中的url改成自己gitee pages的地址,这是因为gitee pages提供的是托管静态网页的服务,而静态页面要定位到资源要先确定基准地址。笔者修改完成后的config.toml内容如下,具体内容根据你的情况修改:

baseURL = "http://focksor.gitee.io/"
languageCode = "en-us"
title = "focksor's pages"
theme = "angels-ladder"

修改完配置文件后,就可以使用hugo -D即可完成站点的编译,或者使用hugo完成编译不带草稿文档的站点。

PS C:\Users\focks\path\website> hugo -D
Building sites …
                   | EN
-------------------+-----
  Pages            |  9
  Paginator pages  |  0
  Non-page files   |  0
  Static files     |  8
  Processed images |  0
  Aliases          |  1
  Sitemaps         |  1
  Cleaned          |  0

Total in 58 ms

编译完成的站点存放地址为path/website/public,如果你想更改生成的地址,可以使用hugo -d yourDir以指定编译站点的地址。

部署到gitee

先将你的gitee pages对应的仓库clone到本地:

PS C:\Users\focks\Downloads> git clone https://gitee.com/focksor/focksor.git
Cloning into 'focksor'...
remote: Enumerating objects: 6, done.
remote: Counting objects: 100% (6/6), done.
remote: Compressing objects: 100% (3/3), done.
remote: Total 6 (delta 0), reused 0 (delta 0)
Unpacking objects: 100% (6/6), 475 bytes | 13.00 KiB/s, done.

完成后,进入该目录,并将编译完成的站点内的所有文件复制到该目录下,完成后的目录结构如下:

PS C:\Users\focks\Downloads> cd .\focksor\
PS C:\Users\focks\Downloads\focksor> tree
文件夹 PATH 列表
卷序列号为 8699-61CD
C:.
├─categories
├─css
├─images
├─js
├─page
│  └─1
├─post
│  └─first
└─tags

添加新加入的文件并提交推送到gitee服务器:

C:\Users\focks\Downloads\focksor>git add .

C:\Users\focks\Downloads\focksor>git commit -m "gitee pages test"
[master db9db29] gitee pages test
 20 files changed, 1399 insertions(+), 2 deletions(-)
 delete mode 100644 CNAME
 create mode 100644 categories/index.html
 create mode 100644 categories/index.xml
 create mode 100644 css/custom.css
 create mode 100644 css/highlight_monokai.css
 create mode 100644 css/responsive.css
 create mode 100644 css/sanitize.css
 create mode 100644 css/theme.css
 create mode 100644 css/theme.less
 create mode 100644 images/profile.png
 rewrite index.html (100%)
 create mode 100644 index.xml
 create mode 100644 js/highlight.pack.js
 create mode 100644 page/1/index.html
 create mode 100644 post/first/index.html
 create mode 100644 post/index.html
 create mode 100644 post/index.xml
 create mode 100644 sitemap.xml
 create mode 100644 tags/index.html
 create mode 100644 tags/index.xml

C:\Users\focks\Downloads\focksor>git push
Enumerating objects: 32, done.
Counting objects: 100% (32/32), done.
Delta compression using up to 4 threads
Compressing objects: 100% (24/24), done.
Writing objects: 100% (30/30), 34.71 KiB | 4.96 MiB/s, done.
Total 30 (delta 8), reused 0 (delta 0)
remote: Powered by GITEE.COM [GNK-3.8]
To https://gitee.com/focksor/focksor.git
   4fc1e10..db9db29  master -> master

完成后,访问你的gitee pages仓库(如:https://gitee.com/focksor/focksor)可以看到远程仓库的文件已经更新了,但是访问gitee pages地址(如:http://focksor.gitee.io/)会发现gitee pages并没有更新,这是因为gitee pages提交后要手动重新部署。使用以下步骤进行重新部署:服务 -> Gitee Pages -> 更新。具体操作如下图:

gitee pages重新部署

等待gitee后台完成部署后,再次访问你的gitee pages(如:http://focksor.gitee.io/),可发现gitee pages已经更新了。

写在最后

为何一篇介绍gitee pages搭建的文章会发布在不是gitee pages的地方?

因为gitee pages麻烦。

猜你喜欢

转载自www.cnblogs.com/focksor/p/how_to_build_gitee_pages.html