README.zh.md

Hugo Compost 主题

Compost 是一个简单、轻量级的 Hugo 主题。主要基于 Congo 改造，并参考了 hugo-starter-tailwind-basic 等。

🌏演示站点

特性

• 样式基于 Tailwind CSS 3.x，以及官方的 Typography 插件。
• 可以使用 hugo 命令直接构建和测试（使用了 #8343 中提到的一些技巧）。
• 🌐 特别为简体中文语言定制了文章样式（只在 html 的 lang 为 zh 时应用）。
• ✨ 使用 Hugo 内置功能自动调整图片大小，并添加原生延迟加载属性。

使用

0. 本主题使用 go modules，不是 git submodule，先确认满足要求并阅读说明。（Windows 用户额外注意）

1. 在 Hugo 项目配置文件 hugo.toml 里指定主题为 github.com/canstand/compost，并且配置需要从主题合并的默认选项：

# required
[build]
  _merge = 'deep'

# required
[markup]
  _merge = 'deep'

# for better seo
[minify]
  _merge = 'deep'

# required
[module]
[[module.mounts]]
  source = 'assets'
  target = 'assets'
[[module.mounts]]
  source = "hugo_stats.json"
  target = "assets/watching/hugo_stats.json"
[[module.imports]]
  path="github.com/canstand/compost"

2. 安装或升级依赖：

hugo mod get -u
hugo mod npm pack
npm install

3. 之后按正常开发与测试：

hugo server