fcc3ed651Remove some expired new-ina9c5981f5Fix cascade example82bb250faAdd some lines about permalinks tokens in front matter328fe564eRemove some outdated new-infb140b153Hide showcase menu entry42d9d1c79Update image formats from which EXIF data can be extracted09ad56b6enetlify: Hugo 0.130.01d503f846Merge branch 'tempv0.130.0'e2458074dmath: Add trigonometric functions and some angle helper functions392afc8f9Disable the showcase section for now0300750f2Improve example of image render hook60a9306afImprove description of the .Site.RegularPages method8d759175dFix typos55daa4554Update XxHash.md397c81cb7Add namespace for hash functions70fe8d2f0netlify: Bump Hugo 0.129.05a9771affMerge branch 'tempv0.129.0'f9146575bFix typoe6e1fea49Fix typo in Hugo docs | functions | partial732d10ec4source: Expose GitInfo Body34c97e639netlify: Hugo 0.128.23270587e9Fix typo727c5396enetlify: Hugo 0.128.180b6ae99cUpdate GitHub Pages workflow file example027134102Update GitHub Pages workflow file example2600a8a2eMiscellaneous edits3fdd5819bUpdate Build.md7764005c3Improve example of render hook directory structure5e3941d82Fix typos748bf065fRestructure templates sectionfafbf6566Update Defer.md012162e0dDocument changes to template functions in v0.128.00990ce35bquick-reference: Update emojis6677a30efUpdate Goldmark configuration documentation4449d530dDocument new pagination config0af8be439Update Defer.md56348196dnetlify: Hugo 0.128.0d67b6d82eUpdate content/en/functions/templates/Defer.md23d996b3dUpdate content/en/functions/templates/Defer.md7f7fb2f27Document templates.Defer5ada1e9d5Fix docs merge (remove shortcode)d27ee6156Merge branch 'tempv0.128.0'5d7317c84Fix typo7c18ee546Update theme83bfea63bUpdate themeb274b3238Merge commit '8b9803425e63e1b1801f8d5d676e96368d706722'ff34a035adeploy: Add stripIndexHtml target optiond9e964bdbmarkup/goldmark: Add the Hugo Goldmark Extras "delete" extensionac5bd16d2deps: Upgrade github.com/alecthomas/chroma v2.13.0 => v2.14.025377171bconfig: Remove extraneous BuildConfig setting0d2044f6ddocs: Regen docshelpera2548dac9markup/goldmark: Support extras extension9d0c86ee8commands: Add gen chromastyles --lineNumbersTableStyle flag git-subtree-dir: docs git-subtree-split:fcc3ed651a
8.3 KiB
title, description, categories, keywords, action, toc, expiryDate
| title | description | categories | keywords | action | toc | expiryDate | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| resources.ToCSS | Transpiles Sass to CSS. |
|
true | 2025-06-24 |
{{% deprecated-in 0.128.0 %}} Use css.Sass instead.
{{% /deprecated-in %}}
{{ with resources.Get "sass/main.scss" }}
{{ $opts := dict "transpiler" "libsass" "targetPath" "css/style.css" }}
{{ with . | toCSS $opts }}
{{ if hugo.IsDevelopment }}
<link rel="stylesheet" href="{{ .RelPermalink }}">
{{ else }}
{{ with . | minify | fingerprint }}
<link rel="stylesheet" href="{{ .RelPermalink }}" integrity="{{ .Data.Integrity }}" crossorigin="anonymous">
{{ end }}
{{ end }}
{{ end }}
{{ end }}
Transpile Sass to CSS using the LibSass transpiler included in Hugo's extended edition, or install Dart Sass to use the latest features of the Sass language.
Sass has two forms of syntax: SCSS and indented. Hugo supports both.
Options
- transpiler
- (
string) The transpiler to use, eitherlibsass(default) ordartsass. Hugo's extended edition includes the LibSass transpiler. To use the Dart Sass transpiler, see the installation instructions below. - targetPath
- (
string) If not set, the transformed resource's target path will be the original path of the asset file with its extension replaced by.css. - vars
- (
map) A map of key-value pairs that will be available in thehugo:varsnamespace. Useful for initializing Sass variables from Hugo templates.
// LibSass
@import "hugo:vars";
// Dart Sass
@use "hugo:vars" as v;
- outputStyle
- (
string) Output styles available to LibSass includenested(default),expanded,compact, andcompressed. Output styles available to Dart Sass includeexpanded(default) andcompressed. - precision
- (
int) Precision of floating point math. Not applicable to Dart Sass. - enableSourceMap
- (
bool) Iftrue, generates a source map. - sourceMapIncludeSources
- (
bool) Iftrue, embeds sources in the generated source map. Not applicable to LibSass. - includePaths
- (
slice) A slice of paths, relative to the project root, that the transpiler will use when resolving@useand@importstatements.
{{ $opts := dict
"transpiler" "dartsass"
"targetPath" "css/style.css"
"vars" site.Params.styles
"enableSourceMap" (not hugo.IsProduction)
"includePaths" (slice "node_modules/bootstrap/scss")
}}
{{ with resources.Get "sass/main.scss" | toCSS $opts | minify | fingerprint }}
<link rel="stylesheet" href="{{ .RelPermalink }}" integrity="{{ .Data.Integrity }}" crossorigin="anonymous">
{{ end }}
Dart Sass
The extended version of Hugo includes LibSass to transpile Sass to CSS. In 2020, the Sass team deprecated LibSass in favor of Dart Sass.
Use the latest features of the Sass language by installing Dart Sass in your development and production environments.
Installation overview
Dart Sass is compatible with Hugo v0.114.0 and later.
If you have been using Embedded Dart Sass1 with Hugo v0.113.0 and earlier, uninstall Embedded Dart Sass, then install Dart Sass. If you have installed both, Hugo will use Dart Sass.
If you install Hugo as a Snap package there is no need to install Dart Sass. The Hugo Snap package includes Dart Sass.
Installing in a development environment
When you install Dart Sass somewhere in your PATH, Hugo will find it.
| OS | Package manager | Site | Installation |
|---|---|---|---|
| Linux | Homebrew | brew.sh | brew install sass/sass/sass |
| Linux | Snap | snapcraft.io | sudo snap install dart-sass |
| macOS | Homebrew | brew.sh | brew install sass/sass/sass |
| Windows | Chocolatey | chocolatey.org | choco install sass |
| Windows | Scoop | scoop.sh | scoop install sass |
You may also install prebuilt binaries for Linux, macOS, and Windows.
Run hugo env to list the active transpilers.
Installing in a production environment
For CI/CD deployments (e.g., GitHub Pages, GitLab Pages, Netlify, etc.) you must edit the workflow to install Dart Sass before Hugo builds the site2 . Some providers allow you to use one of the package managers above, or you can download and extract one of the prebuilt binaries.
GitHub Pages
To install Dart Sass for your builds on GitHub Pages, add this step to the GitHub Pages workflow file:
- name: Install Dart Sass
run: sudo snap install dart-sass
If you are using GitHub Pages for the first time with your repository, GitHub provides a starter workflow for Hugo that includes Dart Sass. This is the simplest way to get started.
GitLab Pages
To install Dart Sass for your builds on GitLab Pages, the .gitlab-ci.yml file should look something like this:
variables:
HUGO_VERSION: 0.128.0
DART_SASS_VERSION: 1.77.5
GIT_DEPTH: 0
GIT_STRATEGY: clone
GIT_SUBMODULE_STRATEGY: recursive
TZ: America/Los_Angeles
image:
name: golang:1.20-buster
pages:
script:
# Install Dart Sass
- curl -LJO https://github.com/sass/dart-sass/releases/download/${DART_SASS_VERSION}/dart-sass-${DART_SASS_VERSION}-linux-x64.tar.gz
- tar -xf dart-sass-${DART_SASS_VERSION}-linux-x64.tar.gz
- cp -r dart-sass/* /usr/local/bin
- rm -rf dart-sass*
# Install Hugo
- curl -LJO https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb
- apt install -y ./hugo_extended_${HUGO_VERSION}_linux-amd64.deb
- rm hugo_extended_${HUGO_VERSION}_linux-amd64.deb
# Build
- hugo --gc --minify
artifacts:
paths:
- public
rules:
- if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
Netlify
To install Dart Sass for your builds on Netlify, the netlify.toml file should look something like this:
[build.environment]
HUGO_VERSION = "0.128.0"
DART_SASS_VERSION = "1.77.5"
TZ = "America/Los_Angeles"
[build]
publish = "public"
command = """\
curl -LJO https://github.com/sass/dart-sass/releases/download/${DART_SASS_VERSION}/dart-sass-${DART_SASS_VERSION}-linux-x64.tar.gz && \
tar -xf dart-sass-${DART_SASS_VERSION}-linux-x64.tar.gz && \
rm dart-sass-${DART_SASS_VERSION}-linux-x64.tar.gz && \
export PATH=/opt/build/repo/dart-sass:$PATH && \
hugo --gc --minify \
"""
Example
To transpile with Dart Sass, set transpiler to dartsass in the options map passed to resources.ToCSS. For example:
{{ with resources.Get "sass/main.scss" }}
{{ $opts := dict "transpiler" "dartsass" "targetPath" "css/style.css" }}
{{ with . | toCSS $opts }}
{{ if hugo.IsDevelopment }}
<link rel="stylesheet" href="{{ .RelPermalink }}">
{{ else }}
{{ with . | minify | fingerprint }}
<link rel="stylesheet" href="{{ .RelPermalink }}" integrity="{{ .Data.Integrity }}" crossorigin="anonymous">
{{ end }}
{{ end }}
{{ end }}
{{ end }}
Miscellaneous
If you build Hugo from source and run mage test -v, the test will fail if you install Dart Sass as a Snap package. This is due to the Snap package's strict confinement model.
-
In 2023, the Sass team deprecated Embedded Dart Sass in favor of Dart Sass. ↩︎
-
You do not have to do this if (a) you have not modified the assets cache location, and (b) you have not set
useResourceCacheWhentoneverin your site configuration, and (c) you add and commit your resources directory to your repository. ↩︎