TheCloud/hugoDocs
1
0
Fork 0
mirror of https://github.com/gohugoio/hugoDocs.git synced 2025-09-14 20:04:44 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fix function signatures

Browse Source
This commit is contained in:
Joe Mooring 2023-10-28 11:08:07 -07:00 committed by GitHub
parent 8182a27ed4
commit 4d936aee62
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 43 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
content/en/functions/images/index.md
View File

@ -17,9 +17,9 @@ See [images.Filter](#filter) for how to apply these filters to an image.
{{< new-in "0.119.0" >}} {{< new-in "0.119.0" >}}
{{% funcsig %}} {{< funcsig >}}
images.Process SRC SPEC images.Process SRC SPEC
{{% /funcsig %}} {{< /funcsig >}}
A general purpose image processing function. A general purpose image processing function.
@ -36,9 +36,9 @@ This filter has all the same options as the [Process](/content-management/image-
## Overlay ## Overlay
{{% funcsig %}} {{< funcsig >}}
images.Overlay SRC X Y images.Overlay SRC X Y
{{% /funcsig %}} {{< /funcsig >}}
Overlay creates a filter that overlays the source image at position x y, e.g: Overlay creates a filter that overlays the source image at position x y, e.g:
@ -60,9 +60,9 @@ The above will overlay `$logo` in the upper left corner of `$img` (at position `
{{< new-in "0.119.0" >}} {{< new-in "0.119.0" >}}
{{% funcsig %}} {{< funcsig >}}
images.Opacity SRC OPACITY images.Opacity SRC OPACITY
{{% /funcsig %}} {{< /funcsig >}}
Opacity creates a filter that changes the opacity of an image. Opacity creates a filter that changes the opacity of an image.
The OPACITY parameter must be in range (0, 1). The OPACITY parameter must be in range (0, 1).
@ -84,9 +84,9 @@ This filter is most useful for target formats that support transparency, e.g. PN
Using the `Text` filter, you can add text to an image. Using the `Text` filter, you can add text to an image.
{{% funcsig %}} {{< funcsig >}}
images.Text TEXT MAP) images.Text TEXT MAP)
{{% /funcsig %}} {{< /funcsig >}}
The following example will add the text `Hugo rocks!` to the image with the specified color, size and position. The following example will add the text `Hugo rocks!` to the image with the specified color, size and position.
@ -115,27 +115,27 @@ You can load a custom font if needed. Load the font as a Hugo `Resource` and set
## Brightness ## Brightness
{{% funcsig %}} {{< funcsig >}}
images.Brightness PERCENTAGE images.Brightness PERCENTAGE
{{% /funcsig %}} {{< /funcsig >}}
Brightness creates a filter that changes the brightness of an image. Brightness creates a filter that changes the brightness of an image.
The percentage parameter must be in range (-100, 100). The percentage parameter must be in range (-100, 100).
### ColorBalance ### ColorBalance
{{% funcsig %}} {{< funcsig >}}
images.ColorBalance PERCENTAGERED PERCENTAGEGREEN PERCENTAGEBLUE images.ColorBalance PERCENTAGERED PERCENTAGEGREEN PERCENTAGEBLUE
{{% /funcsig %}} {{< /funcsig >}}
ColorBalance creates a filter that changes the color balance of an image. ColorBalance creates a filter that changes the color balance of an image.
The percentage parameters for each color channel (red, green, blue) must be in range (-100, 500). The percentage parameters for each color channel (red, green, blue) must be in range (-100, 500).
## Colorize ## Colorize
{{% funcsig %}} {{< funcsig >}}
images.Colorize HUE SATURATION PERCENTAGE images.Colorize HUE SATURATION PERCENTAGE
{{% /funcsig %}} {{< /funcsig >}}
Colorize creates a filter that produces a colorized version of an image. Colorize creates a filter that produces a colorized version of an image.
The hue parameter is the angle on the color wheel, typically in range (0, 360). The hue parameter is the angle on the color wheel, typically in range (0, 360).
@ -144,18 +144,18 @@ The percentage parameter specifies the strength of the effect, it must be in ran
## Contrast ## Contrast
{{% funcsig %}} {{< funcsig >}}
images.Contrast PERCENTAGE images.Contrast PERCENTAGE
{{% /funcsig %}} {{< /funcsig >}}
Contrast creates a filter that changes the contrast of an image. Contrast creates a filter that changes the contrast of an image.
The percentage parameter must be in range (-100, 100). The percentage parameter must be in range (-100, 100).
## Gamma ## Gamma
{{% funcsig %}} {{< funcsig >}}
images.Gamma GAMMA images.Gamma GAMMA
{{% /funcsig %}} {{< /funcsig >}}
Gamma creates a filter that performs a gamma correction on an image. Gamma creates a filter that performs a gamma correction on an image.
The gamma parameter must be positive. Gamma = 1 gives the original image. The gamma parameter must be positive. Gamma = 1 gives the original image.
@ -163,75 +163,75 @@ Gamma less than 1 darkens the image and gamma greater than 1 lightens it.
## GaussianBlur ## GaussianBlur
{{% funcsig %}} {{< funcsig >}}
images.GaussianBlur SIGMA images.GaussianBlur SIGMA
{{% /funcsig %}} {{< /funcsig >}}
GaussianBlur creates a filter that applies a gaussian blur to an image. GaussianBlur creates a filter that applies a gaussian blur to an image.
## Grayscale ## Grayscale
{{% funcsig %}} {{< funcsig >}}
images.Grayscale images.Grayscale
{{% /funcsig %}} {{< /funcsig >}}
Grayscale creates a filter that produces a grayscale version of an image. Grayscale creates a filter that produces a grayscale version of an image.
## Hue ## Hue
{{% funcsig %}} {{< funcsig >}}
images.Hue SHIFT images.Hue SHIFT
{{% /funcsig %}} {{< /funcsig >}}
Hue creates a filter that rotates the hue of an image. Hue creates a filter that rotates the hue of an image.
The hue angle shift is typically in range -180 to 180. The hue angle shift is typically in range -180 to 180.
## Invert ## Invert
{{% funcsig %}} {{< funcsig >}}
images.Invert images.Invert
{{% /funcsig %}} {{< /funcsig >}}
Invert creates a filter that negates the colors of an image. Invert creates a filter that negates the colors of an image.
## Pixelate ## Pixelate
{{% funcsig %}} {{< funcsig >}}
images.Pixelate SIZE images.Pixelate SIZE
{{% /funcsig %}} {{< /funcsig >}}
Pixelate creates a filter that applies a pixelation effect to an image. Pixelate creates a filter that applies a pixelation effect to an image.
## Saturation ## Saturation
{{% funcsig %}} {{< funcsig >}}
images.Saturation PERCENTAGE images.Saturation PERCENTAGE
{{% /funcsig %}} {{< /funcsig >}}
Saturation creates a filter that changes the saturation of an image. Saturation creates a filter that changes the saturation of an image.
## Sepia ## Sepia
{{% funcsig %}} {{< funcsig >}}
images.Sepia PERCENTAGE images.Sepia PERCENTAGE
{{% /funcsig %}} {{< /funcsig >}}
Sepia creates a filter that produces a sepia-toned version of an image. Sepia creates a filter that produces a sepia-toned version of an image.
## Sigmoid ## Sigmoid
{{% funcsig %}} {{< funcsig >}}
images.Sigmoid MIDPOINT FACTOR images.Sigmoid MIDPOINT FACTOR
{{% /funcsig %}} {{< /funcsig >}}
Sigmoid creates a filter that changes the contrast of an image using a sigmoidal function and returns the adjusted image. Sigmoid creates a filter that changes the contrast of an image using a sigmoidal function and returns the adjusted image.
It's a non-linear contrast change useful for photo adjustments as it preserves highlight and shadow detail. It's a non-linear contrast change useful for photo adjustments as it preserves highlight and shadow detail.
## UnsharpMask ## UnsharpMask
{{% funcsig %}} {{< funcsig >}}
images.UnsharpMask SIGMA AMOUNT THRESHOLD images.UnsharpMask SIGMA AMOUNT THRESHOLD
{{% /funcsig %}} {{< /funcsig >}}
UnsharpMask creates a filter that sharpens an image. UnsharpMask creates a filter that sharpens an image.
The sigma parameter is used in a gaussian function and affects the radius of effect. The sigma parameter is used in a gaussian function and affects the radius of effect.
@ -243,9 +243,9 @@ The threshold parameter controls the minimum brightness change that will be shar
### Filter ### Filter
{{% funcsig %}} {{< funcsig >}}
IMAGE | images.Filter FILTERS... IMAGE | images.Filter FILTERS...
{{% /funcsig %}} {{< /funcsig >}}
Can be used to apply a set of filters to an image: Can be used to apply a set of filters to an image:
@ -261,9 +261,9 @@ Parses the image and returns the height, width, and color model.
The `imageConfig` function takes a single parameter, a file path (_string_) relative to the _project's root directory_, with or without a leading slash. The `imageConfig` function takes a single parameter, a file path (_string_) relative to the _project's root directory_, with or without a leading slash.
{{% funcsig %}} {{< funcsig >}}
images.ImageConfig PATH images.ImageConfig PATH
{{% /funcsig %}} {{< /funcsig >}}
```go-html-template ```go-html-template
{{ with (imageConfig "favicon.ico") }} {{ with (imageConfig "favicon.ico") }}

2
layouts/partials/docs/functions-signatures.html
View File

@ -5,7 +5,7 @@
{{- if $.Params.function.returnType }} {{- if $.Params.function.returnType }}
{{- $signature = printf "%s ⟼ %s" . $.Params.function.returnType }} {{- $signature = printf "%s ⟼ %s" . $.Params.function.returnType }}
{{- end }} {{- end }}
<pre class="f5 mb4 ph3 pv2 bg-light-gray" style="border-left:4px solid #0594CB;"> <pre class="f5 mb4 ph3 pv2 bg-light-gray overflow-x-auto" style="border-left:4px solid #0594CB;">
{{- $signature -}} {{- $signature -}}
</pre> </pre>
{{- end }} {{- end }}

4
layouts/shortcodes/funcsig.html
View File

@ -1,4 +1,4 @@
<h4 class="minor mb1 pt2 primary-color-dark">Syntax</h4> <h4 class="minor mb1 pt2 primary-color-dark">Syntax</h4>
<pre class="f5 mb4 ph3 pv2 bg-light-gray" style="border-left:4px solid #0594CB;"> <pre class="f5 mb4 ph3 pv2 bg-light-gray overflow-x-auto" style="border-left:4px solid #0594CB;">
{{- .Inner -}} {{- .Inner -}}
</pre> </pre>