59 lines
1.8 KiB
Markdown
59 lines
1.8 KiB
Markdown
# Hugo Basic Starter for TailwindCSS v3.x
|
|
|
|
[](https://app.netlify.com/sites/lucid-nightingale-60a4e2/deploys)
|
|
|
|
A very simple starter set up with [TailwindCSS](https://tailwindcss.com/) and its [typography plugin](https://tailwindcss.com/docs/typography-plugin) and a build setup using [PostCSS](https://postcss.org/) 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](https://developers.google.com/speed/pagespeed/insights/?url=https%3A%2F%2Flucid-nightingale-60a4e2.netlify.app%2F&tab=mobile).
|
|
|
|
|
|
This setup can be used both as a starter project and a theme.
|
|
|
|
## As a Project
|
|
|
|
```bash
|
|
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:
|
|
|
|
```bash
|
|
hugo mod npm pack
|
|
npm install
|
|
```
|
|
|
|
You need to add (something like) this to your `hugo.toml`:
|
|
|
|
```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.
|