mirror of
https://github.com/gohugoio/hugo.git
synced 2024-12-28 14:01:04 +00: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
87 lines
2.2 KiB
Go
87 lines
2.2 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 paths
|
|
|
|
import (
|
|
"fmt"
|
|
"net/url"
|
|
"strings"
|
|
)
|
|
|
|
// A BaseURL in Hugo is normally on the form scheme://path, but the
|
|
// form scheme: is also valid (mailto:hugo@rules.com).
|
|
type BaseURL struct {
|
|
url *url.URL
|
|
urlStr string
|
|
}
|
|
|
|
func (b BaseURL) String() string {
|
|
if b.urlStr != "" {
|
|
return b.urlStr
|
|
}
|
|
return b.url.String()
|
|
}
|
|
|
|
func (b BaseURL) Path() string {
|
|
return b.url.Path
|
|
}
|
|
|
|
// HostURL returns the URL to the host root without any path elements.
|
|
func (b BaseURL) HostURL() string {
|
|
return strings.TrimSuffix(b.String(), b.Path())
|
|
}
|
|
|
|
// WithProtocol returns the BaseURL prefixed with the given protocol.
|
|
// The Protocol is normally of the form "scheme://", i.e. "webcal://".
|
|
func (b BaseURL) WithProtocol(protocol string) (string, error) {
|
|
u := b.URL()
|
|
|
|
scheme := protocol
|
|
isFullProtocol := strings.HasSuffix(scheme, "://")
|
|
isOpaqueProtocol := strings.HasSuffix(scheme, ":")
|
|
|
|
if isFullProtocol {
|
|
scheme = strings.TrimSuffix(scheme, "://")
|
|
} else if isOpaqueProtocol {
|
|
scheme = strings.TrimSuffix(scheme, ":")
|
|
}
|
|
|
|
u.Scheme = scheme
|
|
|
|
if isFullProtocol && u.Opaque != "" {
|
|
u.Opaque = "//" + u.Opaque
|
|
} else if isOpaqueProtocol && u.Opaque == "" {
|
|
return "", fmt.Errorf("Cannot determine BaseURL for protocol %q", protocol)
|
|
}
|
|
|
|
return u.String(), nil
|
|
}
|
|
|
|
// URL returns a copy of the internal URL.
|
|
// The copy can be safely used and modified.
|
|
func (b BaseURL) URL() *url.URL {
|
|
c := *b.url
|
|
return &c
|
|
}
|
|
|
|
func newBaseURLFromString(b string) (BaseURL, error) {
|
|
var result BaseURL
|
|
|
|
base, err := url.Parse(b)
|
|
if err != nil {
|
|
return result, err
|
|
}
|
|
|
|
return BaseURL{url: base, urlStr: base.String()}, nil
|
|
}
|