Overview:

Compost is a lightweight theme for Hugo, primarily based on the Congo theme and incorporating elements from hugo-starter-tailwind-basic. It features styles based on Tailwind CSS 3.x and the official Typography plugin. Compost also provides a customized article style for Simplified Chinese, and automatically resizes images using Hugo’s built-in function while adding lazy loading attributes supported by browsers.

Features:

• Tailwind CSS 3.x: Compost utilizes styles based on Tailwind CSS 3.x, providing a modern and customizable design.
• Typography Plugin: The theme integrates the official Typography plugin, ensuring consistent and visually appealing typography throughout the site.
• Hugo Command Testing: Compost allows for building and testing directly with the Hugo command, utilizing various tricks mentioned in issue #8343.
• Customized Chinese Article Style: For sites using Simplified Chinese, Compost offers a specially customized article style that enhances readability and aesthetics.
• Image Resizing and Lazy Loading: Compost automatically resizes images using Hugo’s built-in function, optimizing loading times. Additionally, it adds native lazy loading attributes supported by browsers for enhanced performance.

Installation:

To install the Compost theme, follow these steps:

1. Make sure your Hugo project is using go modules, not git submodule.
2. Set the theme in your Hugo project by adding the following line to your hugo.toml file:

   theme = "github.com/canstand/compost"
   

3. Install or upgrade the theme’s dependencies by running the following command:

   hugo mod get -u ./...
   

   Make sure to adjust the command based on your Hugo project folder structure.
4. Run your Hugo project as usual.

Summary:

Compost is a minimalistic and lightweight theme for Hugo that incorporates the power of Tailwind CSS 3.x and the official Typography plugin. It offers a range of features including Hugo command testing, customized article styles for Simplified Chinese, and efficient image resizing with lazy loading attributes. By following the provided installation guide, users can easily integrate Compost into their Hugo projects and benefit from its clean design and optimized performance.