Hugo 搭建流程

1

hugo new site <name of site> -f yml

1
2

git init
git branch -m main # 兼容 Github 的设置

1

git submodule add --depth=1 https://github.com/adityatelange/hugo-PaperMod.git themes/PaperMod

1

git submodule update --init --recursive

1

hugo server

1

hugo new posts/my-first-post.md

 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

baseURL: "https://examplesite.com/"
languageCode: zh-cn
title: ExampleSite
theme: PaperMod
timeZone: Asia/Shanghai

enableInlineShortcodes: true
enableGitInfo: true
enableRobotsTXT: true
enableEmoji: true
hasCJKLanguage: true

outputs:
    home: [HTML, RSS, JSON]

Params:
  title: ExampleSite
  description: "ExampleSite description"
  author: xxx
  homeInfoParams:
      Title: Hi there wave
      Content: Can be Info, links, about...

  socialIcons: # optional
      - name: rss
        url: /index.xml

  ShowFullTextinRSS: true
  ShowReadingTime: true
  ShowCodeCopyButtons: true
  DateFormat: "2006-01-02"  # 日期格式化

menu:
  main:
  - identifier: home
    name: 主页
    url: /
    weight: 10
  - identifier: search
    name: 搜索
    url: /search
    weight: 20
  - identifier: tags
    name: 标签
    url: /tags
    weight: 30
  - identifier: archives
    name: 时间轴
    url: /archives
    weight: 40

1
2
3
4
5

---
title: "时间轴"
layout: "archives"
summary: archives
---

1
2
3
4
5
6

---
title: "搜索" # in any language you want
layout: "search" # is necessary
summary: "search"
placeholder: "Typing something..."
---

1

{{ if or .Params.math .Site.Params.math }} {{ partial "math.html" . }} {{ end }}

 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

<script>
  MathJax = {
    tex: {
      inlineMath: [
        ["$", "$"],
        ["\\(", "\\)"],
      ],
      displayMath: [
        ["$$", "$$"],
        ["\\[", "\\]"],
      ],
      processEscapes: true,
      processEnvironments: true,
    },
    options: {
      skipHtmlTags: ["script", "noscript", "style", "textarea", "pre"],
    },
  };

  window.addEventListener("load", (event) => {
    document.querySelectorAll("mjx-container").forEach(function (x) {
      x.parentElement.classList += "has-jax";
    });
  });
</script>
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script
  type="text/javascript"
  id="MathJax-script"
  async
  src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-svg.js"
></script>

 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

# This is a basic workflow to help you get started with Actions

name: Auto Deploy Hugo

# Controls when the workflow will run
on:
  # Triggers the workflow on push or pull request events but only for the main branch
  push:
    branches: [ main ]
  pull_request:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "build"
  build:
    # The type of runner that the job will run on
    runs-on: ubuntu-latest

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
      - uses: actions/checkout@v2
        with:
          submodules: true  # Fetch Hugo themes (true OR recursive)
          fetch-depth: 0    # Fetch all history for .GitInfo and .Lastmod

      - name: Setup Hugo
        uses: peaceiris/actions-hugo@v2
        with:
          hugo-version: latest
          extended: true

      - name: Build
        run: hugo --minify

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        if: ${{ github.ref == 'refs/heads/main' }}
        with:
          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }} # secret 中设置好私钥
          external_repository: your-repo/your-repo.github.io  # Page 仓库
          publish_branch: main  # Page 仓库的分支
          publish_dir: ./public # 静态网页路径
          commit_message: ${{ github.event.head_commit.message }}

1

ssh-keygen -t rsa -b 4096 -C "$(git config user.email)" -f gh-pages -N ""