/hugo-starter-tailwind-basic

A basic and simple to set up Hugo with TailwindCSS starter project.

Primary LanguageHTMLMIT LicenseMIT

Hugo Basic Starter for TailwindCSS v3.x

Netlify Status

A very simple starter set up with TailwindCSS and its typography plugin and a build setup using PostCSS and PurgeCSS (when running the production build).

In the preview deployment on Netlify it currently has a 100 score on both mobile and desktop on Google PageSpeed.

This setup can be used both as a starter project and a theme.

As a Project

npm install
hugo server

As a Theme

Import github.com/bep/hugo-starter-tailwind-basic/v3 (use github.com/bep/hugo-starter-tailwind-basic/v2 if you want/need Tailwind 2.x.) into your project, and then run:

hugo mod npm pack
npm install

You need to add (something like) this to your hugo.toml:

[module]
  [module.hugoVersion]
    extended = false
    min      = "0.112.0"
  [[module.mounts]]
    source = "assets"
    target = "assets"
  [[module.mounts]]
    source = "hugo_stats.json"
    target = "assets/watching/hugo_stats.json"

[build]
  writeStats = true
  [[build.cachebusters]]
    source = "assets/watching/hugo_stats\\.json"
    target = "styles\\.css"
  [[build.cachebusters]]
    source = "(postcss|tailwind)\\.config\\.js"
    target = "css"
  [[build.cachebusters]]
    source = "assets/.*\\.(js|ts|jsx|tsx)"
    target = "js"
  [[build.cachebusters]]
    source = "assets/.*\\.(.*)$"
    target = "$1"

Then run your project as usual.