使用手册：Sam —— 一款简约至上的Hugo主题

使用手册：Sam —— 一款简约至上的Hugo主题

hugo-theme-sam A Simple and Minimalist theme for Hugo with a focus on typography and content. 项目地址: https://gitcode.com/gh_mirrors/hu/hugo-theme-sam

---

安装指南

系统要求

确保已安装Hugo的扩展版。访问Hugo官网以获取最新版本的安装步骤。对于快速下载特定的Hugo扩展版本，可利用以下bash函数或参考Victoria Drake的博客。

Node.js依赖

由于此主题依赖于PostCSS进行样式编译，您需要通过npm安装postcss, postcss-cli以及autoprefixer：

npm install -g postcss postcss-cli autoprefixer

使用Hugo Snap应用时，这些工具需在exampleSite目录内本地安装。

---

项目使用说明

获取主题

作为Hugo模块使用

1. 确保Go语言环境（>=1.12）已安装。

2. 从您的站点根目录初始化一个Hugo模块：

   hugo mod init github.com/您的用户名/my-sam-based-site
   

3. 添加Sam主题为模块依赖：

   hugo mod get github.com/victoriadrake/hugo-theme-sam
   

本地克隆或作为子模块

• 直接克隆到themes目录下：

  git clone https://github.com/victoriadrake/hugo-theme-sam themes/sam
  

• 或者作为子模块添加：

  git submodule add https://github.com/victoriadrake/hugo-theme-sam themes/sam
  

配置站点

• 复制exampleSite/config.toml到您的站点根目录，并调整配置以符合需求。
• 根据是否以模块方式使用主题，修改config.toml中的theme设置。

创建页面与文章

• 新建页面：

  hugo new page.md
  

• 新建文章：

  hugo new posts/文章标题.md
  

设计主菜单与索引页

编辑config.toml，自定义[[params.mainMenu]]，定制您的索引页和导航菜单项。

局部预览站点

启动Hugo内置服务器预览：

hugo serve -t sam

图片画廊

• 创建图片集文件夹，并在_index.md指定类型为gallery，Hugo将自动处理图像生成画廊页面。

自定义视频背景

在config.toml中配置视频源和可选的覆盖颜色，实现主页的循环视频背景。

---

API使用文档

该主题不直接提供对外API，配置与定制主要通过Hugo的标准配置文件config.toml以及Sass文件的自定义完成。

---

安装方式总结

本部分已在“安装指南”中详细阐述，概括来说，包含系统准备（Hugo扩展版、Node.js相关包）、获取主题（模块化或本地部署）、站点配置、创建内容等几个关键步骤，确保遵循上述指引，即可顺利部署和使用Sam主题。

hugo-theme-sam A Simple and Minimalist theme for Hugo with a focus on typography and content. 项目地址: https://gitcode.com/gh_mirrors/hu/hugo-theme-sam