159c843fdFix front matter menu entry examplec3a476a19Document soft deprecation of PAGE.Scratchcdead9785netlify: Hugo 0.138.09169b4da4Update version references3bc6bf431Update embedded.md5c7743b2eUpdate creation instructions for the emoji quick reference109efe3ebDocument the comment shortcode83d7d3005Update themed3c205054netlify: Hugo 0.137.1545290351Handle inline HTML content0204be97dUpdate theme18d09235eRemove JS and CSS that prevents FOUC with client side math rendering63d9dd876Update RenderShortcodes.md064b95539Update output-format-definition.md3744f3be2Describe and refer to the extended/deploy edition3d3302308netlify: Hugo 0.137.0b53aedceaUpdate RenderShortcodes.mdb5f289165Replace HTML comments in markdown with the new comment shortcodec673880b6Remove superfluous right bracketf80b0c61eUpdate faq.md2ede707ebDocument installation on NixOS09b114914Update theme76a9f90b2Update passthrough.md9f3355630Update Scratch.mdbc080ecaaUpdate Store.md1507ede32Update Scratch.md54a90f569Update Store.md7c9145c43Fix broken linkdd15f183bUpdate ToMath.md2b021c34bMove the [build] documentation to its own pagecbb6677ecFix typoac0969063Update ToMath.md7fbdfd7c8netlify: Hugo 0.136.517f54223cUpdate ToMath.md4c9c3bb06Update multilingual.md1432da7bdMake site and page language methods linkablefd5b746cbUpdate urls.mda746f1b3aUpdate urls.mdabf8738e2netlify: Hugo 0.136.4bd8759996Update TrimSpace.md6103c1e84Documents strings.TrimSpace533dd3a7bnetlify: Hugo 0.136.330f3f97cfUpdate quick-start.mdb0d7b41a0Update configuration-markup.md760e5e4f0Update quick-start.md17daeb866Update quick-start.md1e158e723netlify: Hugo 0.136.2d32530839Update themeedb9bee02Update description of url front matter fielde1c576e18netlify: Hugo 0.136.11ad28e1e0Describe how to configure uglyURLs per sectioncbbd4c4fenetlify: Hugo 0.136.0bb7f35e99Merge branch 'tempv0.136.0'706110736docs: Regen CLI docsbf0c7821fUpdate urls.md8c544e6c0Update quick-start.md8d02733d0Update Paginator.mda45327aacUpdate Paginate.md1377ed4deClarify date parsinge19fb8043Document front matter date field aliasesa39951847Update Tailwind CSS installation instructions3be164c35Remove duplicate token05fc815f7commands: Add "hugo build" as an alias for "hugo"cb3cb504cUpdate table render hook exampleefbee0bffClarify resources.GetRemote 404 handling4312d49c9Update compare.Conditional documentation4a46d53b6Update theme93e542d4fnetlify: Hugo 0.135.0b4da1c104Remvoe some old new-in shortcodes4c316f051Update TailwindCSS.mdc2fe91509Update introduction.md906b7c66bUpdate configuration.md5ab6b3cddUpdate documentation.md26fb4bb4cUpdate documentation.mde9e917f37Update version refs83ce07f24netlify: Hugo 0.134.38cb32f802Update front-matter.md94d7f576aUpdate faq.mdfafc1d8d9netlify: Hugo 0.134.2bfe9cdc3dUpdate content-adapters.md9e49ae3e1Document ignoreLogs configuration setting6b47a1d57Update configuration.mdfd98a0372Document CLI options that can be set in configuration07c2400d8Document alternative to Summary methodd053fa163Update to reflect changes in v0.134.1137dc3241Update ContentWithoutSummary.mde8f6427d9netlify: Hugo 0.134.1 git-subtree-dir: docs git-subtree-split:159c843fd7
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 and extended/deploy editions, 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 and extended/deploy editions include 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.137.1
DART_SASS_VERSION: 1.80.6
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.137.1"
DART_SASS_VERSION = "1.80.6"
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. ↩︎