Skip to content
This repository has been archived by the owner on Mar 19, 2024. It is now read-only.
/ compost Public archive
forked from canstand/compost

Compost is a simple theme for Hugo built with tailwindcss.

License

Notifications You must be signed in to change notification settings

youngjoon-lee/compost

This branch is 1 commit ahead of, 2 commits behind canstand/compost:main.

Folders and files

NameName
Last commit message
Last commit date
May 13, 2023
Sep 3, 2023
Nov 19, 2021
Dec 19, 2023
Jul 31, 2023
Nov 16, 2021
Aug 28, 2023
Jan 27, 2022
Jan 28, 2022
Dec 19, 2023
Nov 26, 2021
Nov 26, 2021
Jul 31, 2023
Sep 3, 2023
Nov 19, 2021
Aug 28, 2023
Aug 28, 2023
Jan 12, 2024
Jul 31, 2023
Dec 19, 2023
Dec 19, 2023
Dec 19, 2023
Dec 19, 2023
Nov 25, 2021
Jan 12, 2024
Sep 3, 2023

Repository files navigation

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

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

  2. 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"
  1. Install or upgrade dependencies:
hugo mod get -u
hugo mod npm pack
npm install
  1. Then run your project as usual.
hugo server

About

Compost is a simple theme for Hugo built with tailwindcss.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 73.6%
  • CSS 19.8%
  • JavaScript 6.6%