mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -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
76 lines
2.3 KiB
Go
76 lines
2.3 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 templates contains functions for template processing of Resource objects.
|
|
package templates
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/gohugoio/hugo/helpers"
|
|
"github.com/gohugoio/hugo/resource"
|
|
"github.com/gohugoio/hugo/tpl"
|
|
)
|
|
|
|
// Client contains methods to perform template processing of Resource objects.
|
|
type Client struct {
|
|
rs *resource.Spec
|
|
|
|
textTemplate tpl.TemplateParseFinder
|
|
}
|
|
|
|
// New creates a new Client with the given specification.
|
|
func New(rs *resource.Spec, textTemplate tpl.TemplateParseFinder) *Client {
|
|
if rs == nil {
|
|
panic("must provice a resource Spec")
|
|
}
|
|
if textTemplate == nil {
|
|
panic("must provide a textTemplate")
|
|
}
|
|
return &Client{rs: rs, textTemplate: textTemplate}
|
|
}
|
|
|
|
type executeAsTemplateTransform struct {
|
|
rs *resource.Spec
|
|
textTemplate tpl.TemplateParseFinder
|
|
targetPath string
|
|
data interface{}
|
|
}
|
|
|
|
func (t *executeAsTemplateTransform) Key() resource.ResourceTransformationKey {
|
|
return resource.NewResourceTransformationKey("execute-as-template", t.targetPath)
|
|
}
|
|
|
|
func (t *executeAsTemplateTransform) Transform(ctx *resource.ResourceTransformationCtx) error {
|
|
tplStr := helpers.ReaderToString(ctx.From)
|
|
templ, err := t.textTemplate.Parse(ctx.InPath, tplStr)
|
|
if err != nil {
|
|
return fmt.Errorf("failed to parse Resource %q as Template: %s", ctx.InPath, err)
|
|
}
|
|
|
|
ctx.OutPath = t.targetPath
|
|
|
|
return templ.Execute(ctx.To, t.data)
|
|
}
|
|
|
|
func (c *Client) ExecuteAsTemplate(res resource.Resource, targetPath string, data interface{}) (resource.Resource, error) {
|
|
return c.rs.Transform(
|
|
res,
|
|
&executeAsTemplateTransform{
|
|
rs: c.rs,
|
|
targetPath: helpers.ToSlashTrimLeading(targetPath),
|
|
textTemplate: c.textTemplate,
|
|
data: data,
|
|
},
|
|
)
|
|
}
|