Code Monkey home page Code Monkey logo

compost's Introduction

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

compost's People

Contributors

canstand avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.