README

学开源

目录

简介

本仓库为https://www.xuekaiyuan.com/源代码，仓库在

https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io

版本

v0.1

初始版本，基于

https://github.com/huzhenghui/Hugo-Bootstrap-CSS

位置在

https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/tree/v0.1

v0.2

修改为符合https://www.xuekaiyuan.com/设置

位置在

https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/tree/v0.2

v0.3

增加https://github.com/huzhenghui/posts/为git submodule（子模块）， 并借助GitHub Action在https://github.com/huzhenghui/posts/更新时自动更新， 详见https://www.xuekaiyuan.com/huzhenghui/github/readme/

位置在

https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/tree/v0.3

仓库结构

命令

tree -a -F -I '.git/'

结果

./
├── .github/
│   └── workflows/
│       └── hugo.yml
├── .gitignore
├── .gitmodules
├── .hugo_build.lock
├── README.md -> ./content/xuekaiyuan/README.md
├── archetypes/
│   └── default.md
├── config.toml
├── content/
│   ├── huzhenghui/
│   │   ├── .git
│   │   ├── .github/
│   │   │   └── workflows/
│   │   │       └── main.yml
│   │   ├── GitHub/
│   │   │   └── README.md
│   │   ├── README.md -> ./GitHub/README.md
│   │   └── _index.md
│   └── posts/
│       ├── Hugo-Bootstrap-CSS/
│       │   └── README.md
│       ├── _index.md
│       └── xuekaiyuan/
│           └── README.md
├── layouts/
│   └── _default/
│       ├── baseof.html
│       ├── list.html
│       └── single.html
└── resources/
    └── _gen/
        ├── assets/
        └── images/

17 directories, 18 files

git submodule（子模块）

在https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/中， 运行如下命令将https://github.com/huzhenghui/posts/添加为子模块

git submodule add https://github.com/huzhenghui/posts content/huzhenghui

命令中https://github.com/huzhenghui/posts为子模块仓库的位置， content/huzhenghui为添加的位置，添加后可以看到git submodule（子模块）的配置文件

https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/blob/master/.gitmodules

[submodule "content/huzhenghui"]
 path = content/huzhenghui
 url = https://github.com/huzhenghui/posts

子模块添加在https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/tree/master/content， 其中可以看到huzhenghui，单击即可进入https://github.com/huzhenghui/posts/

GitHub Action

基于GitHub自动创建的Hugo Action，位置在

https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/blob/master/.github/workflows/hugo.yml

Since v0.1 使用GitHub自动创建的Hugo Action

https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/blob/v0.1/.github/workflows/hugo.yml

v0.3 响应https://github.com/huzhenghui/posts/中GitHub Action触发的事件，并增加git submodule（子模块）自动更新。

https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/blob/v0.3/.github/workflows/hugo.yml

其中在on中增加响应repository_dispatch事件， repository_dispatch事件在huzhenghui/posts的GitHub Action文件中触发。

 on:
   # Runs on pushes targeting the default branch
   push:
     branches: ["master"]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
+  repository_dispatch:

在jobs的Checkout之后Setup Pages之前增加Update module

       - name: Checkout
         uses: actions/checkout@v3
         with:
           submodules: recursive
+      - name: Update module
+        run: git submodule update --remote
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v2

Hugo配置

Hugo的配置文件，位置在

https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/blob/master/config.toml

Since v0.1

v0.2 修改为符合https://www.xuekaiyuan.com/设置

https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/blob/v0.2/config.toml

baseURL      = 'https://www.xuekaiyuan.com/'
languageCode = 'zh-cn'
title        = '学开源'

/README.md

软链接，链接到content/posts/xuekaiyuan/README.md

Since v0.2

https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/blob/v0.2/README.md

原型（内容模板）

Hugo自动创建的文件，位置在

https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/blob/master/archetypes/default.md

Since v0.1

https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/blob/v0.1/archetypes/default.md

---
title: "{{ replace .Name "-" " " | title }}"
date: {{ .Date }}
draft: true
---

内容

/content/posts/_index.md

索引页，内容显示在

https://www.xuekaiyuan.com/posts/

文件位置在

https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/blob/master/content/posts/_index.md

Since v0.1

v0.2 修改为符合https://www.xuekaiyuan.com/设置

https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/blob/v0.2/content/posts/_index.md

---
title: 学开源 Posts（索引页标题）
date: 2023-01-19
publishdate: 2023-01-19
---

<!-- markdownlint-disable-next-line MD025 -->
# 学开源 Posts

（索引页正文内容）

/content/posts/xuekaiyuan/README.md

本文件，位置在

https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/blob/master/content/posts/xuekaiyuan/README.md

Since v0.2

https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/blob/v0.2/content/posts/xuekaiyuan/README.md

模板

/layouts/_default/baseof.html

基本模板，位置在

https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/blob/master/layouts/_default/baseof.html

Since v0.1

https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/blob/v0.1/layouts/_default/baseof.html

<!DOCTYPE html>
<html lang="zh-CN">

<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>{{ block "title" . }}
        {{ .Site.Title }}
        {{ end }}
    </title>
    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/css/bootstrap.min.css" rel="stylesheet"
        integrity="sha384-rbsA2VBKQhggwzxH7pPCaAqO46MgnOM80zW1RWuH61DGLwZJEdK2Kadq2F9CUG65" crossorigin="anonymous">
</head>

<body class="container">
    {{ block "main" . }}
    {{ end }}
    {{ block "footer" . }}
    {{ end }}
</body>

</html>

/layouts/_default/list.html

列表页面模版，效果参见

https://www.xuekaiyuan.com/posts/

文件位置在

https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/blob/master/layouts/_default/list.html

Since v0.1

https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/blob/v0.1/layouts/_default/list.html

{{ define "main" }}
<main>
    <article>
        <header>
            <h1 class="display-1">{{.Title}}</h1>
        </header>
        {{.Content}}
    </article>
    <ul class="list-group list-group-flush">
        {{ range .Pages }}
        <li class="list-group-item">
            <a class="link-primary" href="{{.Permalink}}">{{.Date.Format "2006-01-02"}} | {{.Title}}</a>
        </li>
        {{ end }}
    </ul>
</main>
{{ end }}

/layouts/posts/single.html

单独页面模板，效果参见

https://www.xuekaiyuan.com/posts/xuekaiyuan/readme/

文件位置在

https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/blob/master/layouts/_default/single.html

Since v0.1

https://github.com/xuekaiyuan-com/xuekaiyuan-com.github.io/blob/v0.1/layouts/_default/single.html

{{ define "main" }}
<section id="main">
    <h1 id="title" class="display-1">{{ .Title }}</h1>
    <div>
        <article id="content" class="lead">
            {{ .Content }}
        </article>
    </div>
</section>
<aside id="meta">
    <div>
        <section>
            <h4 id="date"> {{ .Date.Format "Mon Jan 2, 2006" }} </h4>
            <h5 id="wordcount"> {{ .WordCount }} Words </h5>
        </section>
        {{ with .GetTerms "topics" }}
        <ul id="topics">
            {{ range . }}
            <li><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></li>
            {{ end }}
        </ul>
        {{ end }}
        {{ with .GetTerms "tags" }}
        <ul id="tags">
            {{ range . }}
            <li><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></li>
            {{ end }}
        </ul>
        {{ end }}
    </div>
    <div>
        {{ with .PrevInSection }}
        <a class="previous link-primary" href="{{.Permalink}}"> {{.Title}}</a>
        {{ end }}
        {{ with .NextInSection }}
        <a class="next link-primary" href="{{.Permalink}}"> {{.Title}}</a>
        {{ end }}
    </div>
</aside>
{{ end }}