mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-29 06:42:08 -05:00
dea71670c0
Before this commit, you would have to use page bundles to do image processing etc. in Hugo.
This commit adds
* A new `/assets` top-level project or theme dir (configurable via `assetDir`)
* A new template func, `resources.Get` which can be used to "get a resource" that can be further processed.
This means that you can now do this in your templates (or shortcodes):
```bash
{{ $sunset := (resources.Get "images/sunset.jpg").Fill "300x200" }}
```
This also adds a new `extended` build tag that enables powerful SCSS/SASS support with source maps. To compile this from source, you will also need a C compiler installed:
```
HUGO_BUILD_TAGS=extended mage install
```
Note that you can use output of the SCSS processing later in a non-SCSSS-enabled Hugo.
The `SCSS` processor is a _Resource transformation step_ and it can be chained with the many others in a pipeline:
```bash
{{ $css := resources.Get "styles.scss" | resources.ToCSS | resources.PostCSS | resources.Minify | resources.Fingerprint }}
<link rel="stylesheet" href="{{ $styles.RelPermalink }}" integrity="{{ $styles.Data.Digest }}" media="screen">
```
The transformation funcs above have aliases, so it can be shortened to:
```bash
{{ $css := resources.Get "styles.scss" | toCSS | postCSS | minify | fingerprint }}
<link rel="stylesheet" href="{{ $styles.RelPermalink }}" integrity="{{ $styles.Data.Digest }}" media="screen">
```
A quick tip would be to avoid the fingerprinting part, and possibly also the not-superfast `postCSS` when you're doing development, as it allows Hugo to be smarter about the rebuilding.
Documentation will follow, but have a look at the demo repo in https://github.com/bep/hugo-sass-test
New functions to create `Resource` objects:
* `resources.Get` (see above)
* `resources.FromString`: Create a Resource from a string.
New `Resource` transformation funcs:
* `resources.ToCSS`: Compile `SCSS` or `SASS` into `CSS`.
* `resources.PostCSS`: Process your CSS with PostCSS. Config file support (project or theme or passed as an option).
* `resources.Minify`: Currently supports `css`, `js`, `json`, `html`, `svg`, `xml`.
* `resources.Fingerprint`: Creates a fingerprinted version of the given Resource with Subresource Integrity..
* `resources.Concat`: Concatenates a list of Resource objects. Think of this as a poor man's bundler.
* `resources.ExecuteAsTemplate`: Parses and executes the given Resource and data context (e.g. .Site) as a Go template.
Fixes #4381
Fixes #4903
Fixes #4858
101 lines
2.7 KiB
Go
101 lines
2.7 KiB
Go
// Copyright 2018 The Hugo Authors. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package scss
|
|
|
|
import (
|
|
"github.com/bep/go-tocss/scss"
|
|
"github.com/gohugoio/hugo/helpers"
|
|
"github.com/gohugoio/hugo/hugolib/filesystems"
|
|
"github.com/gohugoio/hugo/resource"
|
|
"github.com/mitchellh/mapstructure"
|
|
)
|
|
|
|
type Client struct {
|
|
rs *resource.Spec
|
|
sfs *filesystems.SourceFilesystem
|
|
}
|
|
|
|
func New(fs *filesystems.SourceFilesystem, rs *resource.Spec) (*Client, error) {
|
|
return &Client{sfs: fs, rs: rs}, nil
|
|
}
|
|
|
|
type Options struct {
|
|
|
|
// Hugo, will by default, just replace the extension of the source
|
|
// to .css, e.g. "scss/main.scss" becomes "scss/main.css". You can
|
|
// control this by setting this, e.g. "styles/main.css" will create
|
|
// a Resource with that as a base for RelPermalink etc.
|
|
TargetPath string
|
|
|
|
// Default is nested.
|
|
// One of nested, expanded, compact, compressed.
|
|
OutputStyle string
|
|
|
|
// Precision of floating point math.
|
|
Precision int
|
|
|
|
// When enabled, Hugo will generate a source map.
|
|
EnableSourceMap bool
|
|
}
|
|
|
|
type options struct {
|
|
// The options we receive from the end user.
|
|
from Options
|
|
|
|
// The options we send to the SCSS library.
|
|
to scss.Options
|
|
}
|
|
|
|
func (c *Client) ToCSS(res resource.Resource, opts Options) (resource.Resource, error) {
|
|
internalOptions := options{
|
|
from: opts,
|
|
}
|
|
|
|
// Transfer values from client.
|
|
internalOptions.to.Precision = opts.Precision
|
|
internalOptions.to.OutputStyle = scss.OutputStyleFromString(opts.OutputStyle)
|
|
|
|
if internalOptions.to.Precision == 0 {
|
|
// bootstrap-sass requires 8 digits precision. The libsass default is 5.
|
|
// https://github.com/twbs/bootstrap-sass/blob/master/README.md#sass-number-precision
|
|
internalOptions.to.Precision = 8
|
|
}
|
|
|
|
return c.rs.Transform(
|
|
res,
|
|
&toCSSTransformation{c: c, options: internalOptions},
|
|
)
|
|
}
|
|
|
|
type toCSSTransformation struct {
|
|
c *Client
|
|
options options
|
|
}
|
|
|
|
func (t *toCSSTransformation) Key() resource.ResourceTransformationKey {
|
|
return resource.NewResourceTransformationKey("tocss", t.options.from)
|
|
}
|
|
|
|
func DecodeOptions(m map[string]interface{}) (opts Options, err error) {
|
|
if m == nil {
|
|
return
|
|
}
|
|
err = mapstructure.WeakDecode(m, &opts)
|
|
|
|
if opts.TargetPath != "" {
|
|
opts.TargetPath = helpers.ToSlashTrimLeading(opts.TargetPath)
|
|
}
|
|
|
|
return
|
|
}
|