792401 / compost

Compost is a simple theme for Hugo built with tailwindcss.

Compost Theme | Hugo

Compost is a simple, lightweight theme for Hugo. Mainly based on the Congo, also refer to hugo-starter-tailwind-basic and so on.

🌏Demo site | 中文

Features

• Styles are based on Tailwind CSS 3.x, and the official Typography plugin.
• You can build and test directly with the hugo command (using some of the tricks mentioned in #8343).
• 🌐 The article style is specially customized for the Simplified Chinese language (only applied when the lang of html is zh).
• ✨ Automatically resize images with Hugo's built-in function, and add native lazy loading attr (supported by browsers)

Usage

0. This theme uses go modules, not git submodule, to ensure that the requirements are met and to see the instructions. (Notes for Windows users)

1. Set the theme in the Hugo project as github.com/canstand/compost, and add required options to hugo.toml:

# 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. Install or upgrade dependencies:

hugo mod get -u
hugo mod npm pack
npm install

3. Then run your project as usual.

hugo server