Hugo 博客搭建

1
2
3
4

hugo new site MyBlog
cd MyBlog
git init
git submodule add https://github.com/HEIGE-PCloud/DoIt.git themes/DoIt

1
2
3
4
5

---
title: "My First Blog"
date: 2021-02-04T16:18:47+08:00
draft: true
---

1
2

{{< image src="" caption="" height="" width="" >}}
{{< figure src="" link="" target="_blank" title="" caption="" height="" width="" >}}

1
2
3

{{< admonition note "" false >}}
横幅内容
{{< /admonition >}}

1

{{< math >}}$ 行内公式 ${{< /math >}}

1
2
3
4
5

{{< math >}}
$$
公式块
$$
{{< /math >}}

1
2
3

{{< highlight java "linenostart=5, hl_lines=5 7-9" >}}
代码块
{{< /highlight >}}

1
2
3

```java {linenostart=5, hl_lines=[5,"7-9"]}
代码块
```

1

{{< gist backtraxe 9457ba6238b0a98237a17dae16c006b4 >}}

1
2

hugo server/serve
hugo server -D  # 渲染草稿，即也渲染 draft: true 的内容

 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

# 域名
baseURL = "https://backtraxe.github.io/"

# 默认语言 [en, zh-cn, ...]
defaultContentLanguage = "zh-cn"

# 语言 [zh-CN, en-us, ...]
languageCode = "zh-CN"

# 是否包括中日韩文字
hasCJKLanguage = true

# 标题
title = "traXe"

# 主题
theme = "DoIt"

[params]
  # 主题版本
  version = "0.2.X"
  # 网站描述
  description = "这是Backsided的博客"

# 作者配置
[author]
  name = "Backsided"
  email = ""
  link = ""

[menu]
  [[menu.main]]
    identifier = "posts"
    # 你可以在名称 (允许 HTML 格式) 之前添加其他信息, 例如图标
    pre = ""
    # 你可以在名称 (允许 HTML 格式) 之后添加其他信息, 例如图标
    post = ""
    name = "文章"
    url = "/posts/"
    # 当你将鼠标悬停在此菜单链接上时, 将显示的标题
    title = ""
    weight = 1

  [[menu.main]]
    identifier = "tags"
    pre = ""
    post = ""
    name = "标签"
    url = "/tags/"
    title = ""
    weight = 2

  [[menu.main]]
    identifier = "categories"
    pre = ""
    post = ""
    name = "分类"
    url = "/categories/"
    title = ""
    weight = 3

# Hugo 解析文档的配置
[markup]
  # 语法高亮设置 (https://gohugo.io/content-management/syntax-highlighting)
  [markup.highlight]
    # false 是必要的设置 (https://github.com/dillonzq/LoveIt/issues/158)
    noClasses = false

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

[params]
  # 主题版本
  version = "0.2.X"
  # 描述
  description = "这是Backsided的博客"
  # 关键词
  keywords = ["Theme", "Hugo"]
  # 网站默认主题样式 ("light", "dark", "auto")
  defaultTheme = "auto"
  # 公共 git 仓库路径，仅在 enableGitInfo 设为 true 时有效
  gitRepo = ""
  # 选择哈希函数用来 SRI, 为空时表示不使用 SRI
  # ("sha256", "sha384", "sha512", "md5")
  fingerprint = ""
  # 日期格式
  dateFormat = "2006-01-02"
  # 网站图片, 用于 Open Graph 和 Twitter Cards
  images = ["/logo.png"]

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

# 应用图标配置
[params.app]
  # 当添加到 iOS 主屏幕或者 Android 启动器时的标题, 覆盖默认标题
  title = "LoveIt"
  # 是否隐藏网站图标资源链接
  noFavicon = false
  # 更现代的 SVG 网站图标, 可替代旧的 .png 和 .ico 文件
  svgFavicon = ""
  # Android 浏览器主题色
  themeColor = "#ffffff"
  # Safari 图标颜色
  iconColor = "#5bbad5"
  # Windows v8-10磁贴颜色
  tileColor = "#da532c"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

# 搜索配置
[params.search]
  enable = true
  # 搜索引擎的类型 ("lunr", "algolia")
  type = "lunr"
  # 文章内容最长索引长度
  contentLength = 4000
  # 搜索框的占位提示语
  placeholder = ""
  # 最大结果数目
  maxResultLength = 10
  # 结果内容片段长度
  snippetLength = 50
  # 搜索结果中高亮部分的 HTML 标签
  highlightTag = "em"
  # 是否在搜索索引中使用基于 baseURL 的绝对路径
  absoluteURL = false

  [params.search.algolia]
    index = ""
    appID = ""
    searchKey = ""

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

# 页面头部导航栏配置
[params.header]
  # 桌面端导航栏模式 ("fixed", "normal", "auto")
  desktopMode = "fixed"
  # 移动端导航栏模式 ("fixed", "normal", "auto")
  mobileMode = "auto"
  # 页面头部导航栏标题配置
  [params.header.title]
    # LOGO 的 URL
    logo = ""
    # 标题名称
    name = "Backsided's World"
    # 你可以在名称 (允许 HTML 格式) 之前添加其他信息, 例如图标
    pre = ""
    # 你可以在名称 (允许 HTML 格式) 之后添加其他信息, 例如图标
    post = ""
    # 是否为标题显示打字机动画
    typeit = true

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

# 页面底部信息配置
[params.footer]
  enable = true
  # 自定义内容 (支持 HTML 格式)
  custom = ''
  # 是否显示 Hugo 和主题信息
  hugo = true
  # 是否显示版权信息
  copyright = true
  # 是否显示作者
  author = true
  # 网站创立年份
  since = 2021
  # ICP 备案信息，仅在中国使用 (支持 HTML 格式)
  icp = ""
  # 许可协议信息 (支持 HTML 格式)
  license = '<a rel="license external nofollow noopener noreffer" href="https://creativecommons.org/licenses/by-nc/4.0/" target="_blank">CC BY-NC 4.0</a>'

1
2
3
4
5
6
7
8

# Section (所有文章) 页面配置
[params.section]
  # section 页面每页显示文章数量
  paginate = 20
  # 日期格式 (月和日)
  dateFormat = "01-02"
  # RSS 文章数目
  rss = 10

1
2
3
4
5
6
7
8

# List (目录或标签) 页面配置
[params.list]
  # list 页面每页显示文章数量
  paginate = 20
  # 日期格式 (月和日)
  dateFormat = "01-02"
  # RSS 文章数目
  rss = 10

 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

# 主页配置
[params.home]
  # RSS 文章数目
  rss = 10

  # 主页个人信息
  [params.home.profile]
    enable = true
    # Gravatar 邮箱，用于优先在主页显示的头像
    gravatarEmail = ""
    # 主页显示头像的 URL
    avatarURL = "/images/avatar.png"
    # 主页显示的网站标题 (支持 HTML 格式)
    title = ""
    # 主页显示的网站副标题
    subtitle = "这是我的全新 Hugo 网站"
    # 是否为副标题显示打字机动画
    typeit = true
    # 是否显示社交账号
    social = true
    # 免责声明 (支持 HTML 格式)
    disclaimer = ""

  # 主页文章列表
  [params.home.posts]
    enable = true
    # 主页每页显示文章数量
    paginate = 6

 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

# 作者的社交信息设置
[params.social]
  GitHub = "xxxx"
  Linkedin = ""
  Twitter = "xxxx"
  Instagram = "xxxx"
  Facebook = "xxxx"
  Telegram = "xxxx"
  Medium = ""
  Gitlab = ""
  Youtubelegacy = ""
  Youtubecustom = ""
  Youtubechannel = ""
  Tumblr = ""
  Quora = ""
  Keybase = ""
  Pinterest = ""
  Reddit = ""
  Codepen = ""
  FreeCodeCamp = ""
  Bitbucket = ""
  Stackoverflow = ""
  Weibo = ""
  Odnoklassniki = ""
  VK = ""
  Flickr = ""
  Xing = ""
  Snapchat = ""
  Soundcloud = ""
  Spotify = ""
  Bandcamp = ""
  Paypal = ""
  Fivehundredpx = ""
  Mix = ""
  Goodreads = ""
  Lastfm = ""
  Foursquare = ""
  Hackernews = ""
  Kickstarter = ""
  Patreon = ""
  Steam = ""
  Twitch = ""
  Strava = ""
  Skype = ""
  Whatsapp = ""
  Zhihu = ""
  Douban = ""
  Angellist = ""
  Slidershare = ""
  Jsfiddle = ""
  Deviantart = ""
  Behance = ""
  Dribbble = ""
  Wordpress = ""
  Vine = ""
  Googlescholar = ""
  Researchgate = ""
  Mastodon = ""
  Thingiverse = ""
  Devto = ""
  Gitea = ""
  XMPP = ""
  Matrix = ""
  Bilibili = ""
  Email = "xxxx@xxxx.com"
  RSS = true

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

# 文章页面配置
[params.page]
  # 是否在主页隐藏一篇文章
  hiddenFromHomePage = false
  # 是否在搜索结果中隐藏一篇文章
  hiddenFromSearch = false
  # 是否使用 twemoji
  twemoji = false
  # 是否使用 lightgallery
  lightgallery = false
  # 是否使用 ruby 扩展语法
  ruby = true
  # 是否使用 fraction 扩展语法
  fraction = true
  # 是否使用 fontawesome 扩展语法
  fontawesome = true
  # 是否在文章页面显示原始 Markdown 文档链接
  linkToMarkdown = true
  # 是否在 RSS 中显示全文内容
  rssFullText = false

1
2
3
4
5
6
7
8

# 目录配置
[params.page.toc]
  # 是否使用目录
  enable = true
  # 是否保持使用文章前面的静态目录
  keepStatic = true
  # 是否使侧边目录自动折叠展开
  auto = true

1
2
3
4
5
6

# 代码配置
[params.page.code]
  # 是否显示代码块的复制按钮
  copy = true
  # 默认展开显示的代码行数
  maxShownLines = 10

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

# KaTeX 数学公式
[params.page.math]
  enable = true
  # 默认块定界符是 $$ ... $$ 和 \\[ ... \\]
  blockLeftDelimiter = ""
  blockRightDelimiter = ""
  # 默认行内定界符是 $ ... $ 和 \\( ... \\)
  inlineLeftDelimiter = ""
  inlineRightDelimiter = ""
  # KaTeX 插件 copy_tex
  copyTex = true
  # KaTeX 插件 mhchem
  mhchem = true

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

# Mapbox GL JS 配置
[params.page.mapbox]
  # Mapbox GL JS 的 access token
  accessToken = ""
  # 浅色主题的地图样式
  lightStyle = "mapbox://styles/mapbox/light-v9"
  # 深色主题的地图样式
  darkStyle = "mapbox://styles/mapbox/dark-v9"
  # 是否添加 NavigationControl
  navigation = true
  # 是否添加 GeolocateControl
  geolocate = true
  # 是否添加 ScaleControl
  scale = true
  # 是否添加 FullscreenControl
  fullscreen = true

 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

# 文章页面的分享信息设置
[params.page.share]
  enable = true
  Twitter = false
  Facebook = false
  Linkedin = false
  Whatsapp = false
  Pinterest = false
  Tumblr = false
  HackerNews = false
  Reddit = false
  VK = false
  Buffer = false
  Xing = false
  Line = false
  Instapaper = false
  Pocket = false
  Digg = false
  Stumbleupon = false
  Flipboard = false
  Weibo = false
  Renren = false
  Myspace = false
  Blogger = false
  Baidu = false
  Odnoklassniki = false
  Evernote = false
  Skype = false
  Trello = false
  Mix = false

 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

# 评论系统设置
[params.page.comment]
  enable = true

  # Disqus 评论系统设置
  [params.page.comment.disqus]
    enable = false
    # Disqus 的 shortname，用来在文章中启用 Disqus 评论系统
    shortname = ""

  # Gitalk 评论系统设置
  [params.page.comment.gitalk]
    enable = false
    owner = ""
    repo = ""
    clientId = ""
    clientSecret = ""

  # Valine 评论系统设置
  [params.page.comment.valine]
    enable = false
    appId = ""
    appKey = ""
    placeholder = ""
    avatar = "mp"
    meta= ""
    pageSize = 10
    lang = ""
    visitor = true
    recordIP = true
    highlight = true
    enableQQ = false
    serverURLs = ""
    # emoji 数据文件名称, 默认是 "google.yml"
    # ("apple.yml", "google.yml", "facebook.yml", "twitter.yml")
    # 位于 "themes/LoveIt/assets/data/emoji/" 目录
    # 可以在你的项目下相同路径存放你自己的数据文件:
    # "assets/data/emoji/"
    emoji = ""

  # Facebook 评论系统设置
  [params.page.comment.facebook]
    enable = false
    width = "100%"
    numPosts = 10
    appId = ""
    languageCode = "zh_CN"

  # [Telegram Comments](https://comments.app/) 评论系统设置
  [params.page.comment.telegram]
    enable = false
    siteID = ""
    limit = 5
    height = ""
    color = ""
    colorful = true
    dislikes = false
    outlined = false

  # [Commento](https://commento.io/) 评论系统设置
  [params.page.comment.commento]
    enable = false

  # [Utterances](https://utteranc.es/) 评论系统设置
  [params.page.comment.utterances]
    enable = false
    # owner/repo
    repo = ""
    issueTerm = "pathname"
    label = ""
    lightTheme = "github-light"
    darkTheme = "github-dark"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

# 第三方库配置
[params.page.library]
  [params.page.library.css]
    # someCSS = "some.css"
    # 位于 "assets/"
    # 或者
    # someCSS = "https://cdn.example.com/some.css"

  [params.page.library.js]
    # someJavascript = "some.js"
    # 位于 "assets/"
    # 或者
    # someJavascript = "https://cdn.example.com/some.js"

1
2
3
4
5
6
7
8
9

# 页面 SEO 配置
[params.page.seo]
  # 图片 URL
  images = []

  # 出版者信息
  [params.page.seo.publisher]
    name = ""
    logoUrl = ""

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

# TypeIt 配置
[params.typeit]
  # 每一步的打字速度 (单位是毫秒)
  speed = 100
  # 光标的闪烁速度 (单位是毫秒)
  cursorSpeed = 1000
  # 光标的字符 (支持 HTML 格式)
  cursorChar = "|"
  # 打字结束之后光标的持续时间 (单位是毫秒, "-1" 代表无限大)
  duration = -1

1
2
3
4
5
6
7

# 网站验证代码，用于 Google/Bing/Yandex/Pinterest/Baidu
[params.verification]
  google = ""
  bing = ""
  yandex = ""
  pinterest = ""
  baidu = ""

1
2
3
4
5
6

# 网站 SEO 配置
[params.seo]
  # 图片 URL
  image = ""
  # 缩略图 URL
  thumbnailUrl = ""

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

# 网站分析配置
[params.analytics]
  enable = false

  # Google Analytics
  [params.analytics.google]
    id = ""
    # 是否匿名化用户 IP
    anonymizeIP = true

  # Fathom Analytics
  [params.analytics.fathom]
    id = ""
    # 自行托管追踪器时的主机路径
    server = ""

1
2
3
4
5
6
7
8
9

# Cookie 许可配置
[params.cookieconsent]
  enable = true

  # 用于 Cookie 许可横幅的文本字符串
  [params.cookieconsent.content]
    message = ""
    dismiss = ""
    link = ""

1
2
3
4
5
6
7
8

# 第三方库文件的 CDN 设置
[params.cdn]
  # CDN 数据文件名称, 默认不启用
  # ("jsdelivr.yml")
  # 位于 "themes/LoveIt/assets/data/cdn/" 目录
  # 可以在你的项目下相同路径存放你自己的数据文件:
  # "assets/data/cdn/"
  data = ""

1
2
3
4
5
6

# 兼容性设置
[params.compatibility]
  # 是否使用 Polyfill.io 来兼容旧式浏览器
  polyfill = false
  # 是否使用 object-fit-images 来兼容旧式浏览器
  objectFit = false

 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

# Hugo 解析文档的配置
[markup]
  # 语法高亮设置
  [markup.highlight]
    codeFences = true
    guessSyntax = true
    lineNos = true
    lineNumbersInTable = true
    # false 是必要的设置
    # (https://github.com/dillonzq/LoveIt/issues/158)
    noClasses = false

  # Goldmark 是 Hugo 0.60 以来的默认 Markdown 解析库
  [markup.goldmark]
    [markup.goldmark.extensions]
      definitionList = true
      footnote = true
      linkify = true
      strikethrough = true
      table = true
      taskList = true
      typographer = true

    [markup.goldmark.renderer]
      # 是否在文档中直接使用 HTML 标签
      unsafe = true

  # 目录设置
  [markup.tableOfContents]
    startLevel = 2
    endLevel = 6

1
2
3
4
5

# 作者配置
[author]
  name = "xxxx"
  email = ""
  link = ""

1
2
3
4
5

# 网站地图配置
[sitemap]
  changefreq = "weekly"
  filename = "sitemap.xml"
  priority = 0.5

1
2
3
4

# Permalinks 配置
[Permalinks]
  # posts = ":year/:month/:filename"
  posts = ":filename"

1
2
3
4
5
6

# 隐私信息配置
[privacy]
  [privacy.twitter]
    enableDNT = true
  [privacy.youtube]
    privacyEnhanced = true

1
2
3
4

# 用于输出 Markdown 格式文档的设置
[mediaTypes]
  [mediaTypes."text/plain"]
    suffixes = ["md"]

1
2
3
4
5

# 用于输出 Markdown 格式文档的设置
[outputFormats.MarkDown]
  mediaType = "text/plain"
  isPlainText = true
  isHTML = false

1
2
3
4
5
6
7

# 用于 Hugo 输出文档的设置
[outputs]
  home = ["HTML", "RSS", "JSON"]
  page = ["HTML", "MarkDown"]
  section = ["HTML", "RSS"]
  taxonomy = ["HTML", "RSS"]
  taxonomyTerm = ["HTML"]

1
2
3
4

git remote add origin https://github.com/backtraxe/backtraxe.github.io.data.git
git add --all
git commit -m "init blog"
git push --set-upstream origin master -f

 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

name: Hugo Deploy

on:
  push:
    branches: [ main ] # 指定分支

  workflow_dispatch: # 允许手动启动

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: 1. Checkout # 克隆仓库
        uses: actions/checkout@v2
        with:
          submodules: true # 启用子模块
          fetch-depth: 0

      - name: 2. Disable quotePath # 解决中文显示问题
        run: git config --global core.quotePath false

      - name: 3. Setup Hugo # 安装 hugo
        uses: peaceiris/actions-hugo@v2
        with:
          hugo-version: 'latest'
          extended: true

      - name: 4. Build Hugo # 渲染页面
        run: hugo --gc --minify --cleanDestinationDir

      - name: 5. Deploy Hugo # 将渲染后的页面复制到指定仓库，然后发布
        uses: peaceiris/actions-gh-pages@v3
        with:
          personal_token: ${{ secrets.ACCESS_TOKEN }}  # 与 Secrets 的名称相同
          external_repository: backtraxe/backtraxe.github.io  # 指定发布的仓库
          publish_branch: main  # 指定发布仓库的分支
          publish_dir: ./public  # 指定要发布的目录

1

git clone --recursive https://github.com/backtraxe/backtraxe.github.io.data.git

  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

# 域名
baseURL = ""

# 构建时包含草稿
buildDrafts = false

# 内容文件夹
contentDir = "content"

# 数据文件夹
dataDir = "data"

# 内容默认语言（中文：zh-cn）
defaultContentLanguage = "en"

# 根目录跳转到默认语言目录
defaultContentLanguageInSubdir = false

# 禁用指定类型页面：page, home, section, taxonomy, term, RSS, sitemap, robotsTXT, 404
disableKinds = []

# 禁用实时重载
disableLiveReload = false

# 禁用将 url/path 转小写字母
disablePathToLower = false

# 启用 Emoji
enableEmoji = false

# 使用文件的最后 git 提交日期更新 Lastmod 参数
enableGitInfo = false

# 启用 inline shortcode
enableInlineShortcodes = false

# 是否生成 robots.txt 文件
enableRobotsTXT = false

# 日期设置
[frontmatter]

# 脚注锚的前缀
footnoteAnchorPrefix = ""

# 脚注返回链接显示的文本
footnoteReturnLinkContents = ""

# Google Analytics 跟踪 ID
googleAnalytics = ""

# 自动检测内容中的中文/日文/韩文
hasCJKLanguage = false

# 图片设置
[imaging]

# 语言设置
[languages]

# 启用日志
log = false

# 日志保存目录
logFile = ""

# 主题设置
[markup]

# 目录设置
[menu]

# 最小化构建设置
[minify]

# 模块设置
[module]

# 每页的默认文章数量
paginate = 10

# 固定链接
[permalinks]

# 生成静态网页的目录
publishDir = "public"

# 相关设置
[related]

# 网站地图设置
[sitemap]

# 静态文件目录设置
staticDir = "static"

# 分类设置
[taxonomies]

# 主题
theme = ""

# 主题目录
themesDir = "themes"

# 标题
title = ""