floraachy/ky-blog

⚡ Hugo

Hugo 0.134 or higher
Hugo extended version, Installation Instructions

我当前使用的版本是：hugo_extended_0.146.4_windows-amd64

📂Hugo 目录结构

ky-blog/
|-- archetypes 内容模板（生成新内容的默认markdown结构）
|-- --docs.md 文档类型模板
|-- --posts.md 博客类型模板
|-- content 网站内容（markdown文件，按目录组织页面）
|-- layouts 自定义模板（覆盖主题的html模板，优先级高于主题自带的模板）
|-- public 生成后的静态网站（默认输出目录）
|-- resources hugo缓存资源（自动生成，无需手动修改）
|-- static 静态文件（直接复制到输出目录public，如PDF、图片）,适用于无需处理的文件
|-- assets 原始资源文件，可通过hugo pipes处理（如压缩、合并、SCSS转CSS）
|-- themes 主题目录（存放第三方或自定义主题）
|-- hugo.toml 主配置文件，定义全局参数，如网站标题、URL、主题、语言等

🛠️本地调试

1. 环境安装

需要在本地环境安装hugo，安装教程可见：https://www.gitlink.org.cn/zone/tester/newdetail/909

hugo下载地址：https://www.gitlink.org.cn/zone/tester/source/186

2. 开启hugo服务

可以使用如下命令开启hugo服务，开启后使用本机IP+端口即可打开，例如：http://localhost:1313/ 或者 http://172.20.32.10:1313/

hugo server --bind 0.0.0.0 --port 1313  --ignoreCache

📝hugo theme relearn使用

详细教程参考：https://mcshelby.github.io/hugo-theme-relearn/configuration/branding/logo/index.html

🐛 提交代码

如果需要将本地更新提交到远程仓库，需要安装Git工具，再使用如下命令提交：

# 前提：远程仓库已克隆到本地(增加命令--recurse-submodules表示当前仓库以及仓库的子模块都要克隆)
git clone --recurse-submodules https://gitlink.org.cn/floraachy/ky-blog.git

# 配置好用户名和邮箱
git config user.name "gitlink平台login"
git config user.email "gitlink平台邮箱"

# 将更改添加到缓存区
git add .

# 添加注释信息
git commit -m "本次更改了xxx"

# 推送到远程仓库
git push origin master

🛠️Docker部署

1. 使用dockerfile构建docker镜像

# 当前处于ky-blog工作目录下
docker buildx build --build-arg GIT_USERNAME="xxx" --build-arg GIT_PASSWORD="xxx" -f dockerfile -t ky-blog:2.0 .

2. 使用docker镜像运行

docker run --restart=always -d -p 1313:1313 --name kyblog ky-blog:2.0

3. 停止并删除容器及镜像

# 停止容器
docker stop kyblog>/dev/null || echo "kyblog容器未启动或者不存在" 
# 删除容器
docker rm kyblog>/dev/null || echo "kyblog容器不存在"
# 删除镜像
docker rmi ky-blog:2.0>/dev/null || echo "ky-blog:2.镜像不存在"