From 7de6dbab39b03d34e0aca0c97057aa066c5da04d Mon Sep 17 00:00:00 2001 From: Joe Mooring Date: Thu, 6 Mar 2025 13:10:42 -0800 Subject: [PATCH] content: Fix front matter for several function pages --- content/en/functions/collections/NewScratch.md | 2 +- content/en/functions/go-template/end.md | 4 ++-- content/en/functions/resources/Babel.md | 9 +++++---- content/en/functions/resources/ByType.md | 15 +++++---------- content/en/functions/resources/Concat.md | 10 +++++----- content/en/functions/resources/Copy.md | 10 +++++----- .../en/functions/resources/ExecuteAsTemplate.md | 11 +++++------ content/en/functions/resources/Fingerprint.md | 15 +++++---------- content/en/functions/resources/FromString.md | 11 +++++------ content/en/functions/resources/Get.md | 15 +++++---------- content/en/functions/resources/GetMatch.md | 15 +++++---------- content/en/functions/resources/GetRemote.md | 17 +++++------------ content/en/functions/resources/Match.md | 15 +++++---------- content/en/functions/resources/Minify.md | 15 +++++---------- content/en/functions/resources/PostCSS.md | 9 +++++---- content/en/functions/resources/PostProcess.md | 12 +++++------- content/en/functions/resources/ToCSS.md | 9 +++++---- 17 files changed, 78 insertions(+), 116 deletions(-) diff --git a/content/en/functions/collections/NewScratch.md b/content/en/functions/collections/NewScratch.md index 35304719a..34fc7f5d6 100644 --- a/content/en/functions/collections/NewScratch.md +++ b/content/en/functions/collections/NewScratch.md @@ -7,7 +7,7 @@ params: functions_and_methods: aliases: [newScratch] returnType: maps.Scratch - signatures: [collections.NewScratch ] + signatures: [collections.NewScratch ] --- Use the `collections.NewScratch` function to create a locally scoped [scratch pad](g) to store and manipulate data. To create a scratch pad with a different [scope](g), refer to the [scope](#scope) section below. diff --git a/content/en/functions/go-template/end.md b/content/en/functions/go-template/end.md index 21ad1e8a0..6de120724 100644 --- a/content/en/functions/go-template/end.md +++ b/content/en/functions/go-template/end.md @@ -6,8 +6,8 @@ keywords: [] params: functions_and_methods: aliases: [] - returnType: - signatures: [end] + returnType: + signatures: [end] --- Use with the [`if`] statement: diff --git a/content/en/functions/resources/Babel.md b/content/en/functions/resources/Babel.md index 8fd0c58cc..799823fc5 100644 --- a/content/en/functions/resources/Babel.md +++ b/content/en/functions/resources/Babel.md @@ -3,10 +3,11 @@ title: resources.Babel description: Compiles the given JavaScript resource with Babel. categories: [] keywords: [] -action: - related: [] - returnType: resource.Resource - signatures: ['resources.Babel [OPTIONS] RESOURCE'] +params: + functions_and_methods: + aliases: [] + returnType: resource.Resource + signatures: ['resources.Babel [OPTIONS] RESOURCE'] expiryDate: 2026-06-24 # deprecated 2024-06-24 in v0.128.0 --- diff --git a/content/en/functions/resources/ByType.md b/content/en/functions/resources/ByType.md index 273460d8c..e7b73a005 100644 --- a/content/en/functions/resources/ByType.md +++ b/content/en/functions/resources/ByType.md @@ -3,16 +3,11 @@ title: resources.ByType description: Returns a collection of global resources of the given media type, or nil if none found. categories: [] keywords: [] -action: - aliases: [] - related: - - functions/resources/Get - - functions/resources/GetMatch - - functions/resources/GetRemote - - functions/resources/Match - - methods/page/Resources - returnType: resource.Resources - signatures: [resources.ByType MEDIATYPE] +params: + functions_and_methods: + aliases: [] + returnType: resource.Resources + signatures: [resources.ByType MEDIATYPE] --- The [media type] is typically one of `image`, `text`, `audio`, `video`, or `application`. diff --git a/content/en/functions/resources/Concat.md b/content/en/functions/resources/Concat.md index 6e81f3f44..fe7226e1b 100644 --- a/content/en/functions/resources/Concat.md +++ b/content/en/functions/resources/Concat.md @@ -3,11 +3,11 @@ title: resources.Concat description: Returns a concatenated slice of resources. categories: [] keywords: [] -action: - aliases: [] - related: [] - returnType: resource.Resource - signatures: ['resources.Concat TARGETPATH [RESOURCE...]'] +params: + functions_and_methods: + aliases: [] + returnType: resource.Resource + signatures: ['resources.Concat TARGETPATH [RESOURCE...]'] --- The `resources.Concat` function returns a concatenated slice of resources, caching the result using the target path as its cache key. Each resource must have the same [media type]. diff --git a/content/en/functions/resources/Copy.md b/content/en/functions/resources/Copy.md index 946c83c23..39500e57a 100644 --- a/content/en/functions/resources/Copy.md +++ b/content/en/functions/resources/Copy.md @@ -2,11 +2,11 @@ title: resources.Copy description: Copies the given resource to the target path. categories: [] -action: - aliases: [] - related: [] - returnType: resource.Resource - signatures: [resources.Copy TARGETPATH RESOURCE] +params: + functions_and_methods: + aliases: [] + returnType: resource.Resource + signatures: [resources.Copy TARGETPATH RESOURCE] --- ```go-html-template diff --git a/content/en/functions/resources/ExecuteAsTemplate.md b/content/en/functions/resources/ExecuteAsTemplate.md index 0e7d244b2..c1eaec44a 100644 --- a/content/en/functions/resources/ExecuteAsTemplate.md +++ b/content/en/functions/resources/ExecuteAsTemplate.md @@ -3,12 +3,11 @@ title: resources.ExecuteAsTemplate description: Returns a resource created from a Go template, parsed and executed with the given context. categories: [] keywords: [] -action: - aliases: [] - related: - - functions/resources/FromString - returnType: resource.Resource - signatures: [resources.ExecuteAsTemplate TARGETPATH CONTEXT RESOURCE] +params: + functions_and_methods: + aliases: [] + returnType: resource.Resource + signatures: [resources.ExecuteAsTemplate TARGETPATH CONTEXT RESOURCE] --- The `resources.ExecuteAsTemplate` function returns a resource created from a Go template, parsed and executed with the given context, caching the result using the target path as its cache key. diff --git a/content/en/functions/resources/Fingerprint.md b/content/en/functions/resources/Fingerprint.md index 17222784e..6757a0b6f 100644 --- a/content/en/functions/resources/Fingerprint.md +++ b/content/en/functions/resources/Fingerprint.md @@ -3,16 +3,11 @@ title: resources.Fingerprint description: Cryptographically hashes the content of the given resource. categories: [] keywords: [] -action: - aliases: [fingerprint] - related: - - functions/resources/Minify - - functions/css/Sass - - functions/css/TailwindCSS - - functions/js/Build - - functions/js/Babel - returnType: resource.Resource - signatures: ['resources.Fingerprint [ALGORITHM] RESOURCE'] +params: + functions_and_methods: + aliases: [fingerprint] + returnType: resource.Resource + signatures: ['resources.Fingerprint [ALGORITHM] RESOURCE'] --- ```go-html-template diff --git a/content/en/functions/resources/FromString.md b/content/en/functions/resources/FromString.md index c13db35d6..4cd04f609 100644 --- a/content/en/functions/resources/FromString.md +++ b/content/en/functions/resources/FromString.md @@ -3,12 +3,11 @@ title: resources.FromString description: Returns a resource created from a string. categories: [] keywords: [] -action: - aliases: [] - related: - - functions/resources/ExecuteAsTemplate - returnType: resource.Resource - signatures: [resources.FromString TARGETPATH STRING] +params: + functions_and_methods: + aliases: [] + returnType: resource.Resource + signatures: [resources.FromString TARGETPATH STRING] --- The `resources.FromString` function returns a resource created from a string, caching the result using the target path as its cache key. diff --git a/content/en/functions/resources/Get.md b/content/en/functions/resources/Get.md index 1702b0415..40e38b78d 100644 --- a/content/en/functions/resources/Get.md +++ b/content/en/functions/resources/Get.md @@ -3,16 +3,11 @@ title: resources.Get description: Returns a global resource from the given path, or nil if none found. categories: [] keywords: [] -action: - aliases: [] - related: - - functions/resources/ByType - - functions/resources/GetMatch - - functions/resources/GetRemote - - functions/resources/Match - - methods/page/Resources - returnType: resource.Resource - signatures: [resources.Get PATH] +params: + functions_and_methods: + aliases: [] + returnType: resource.Resource + signatures: [resources.Get PATH] --- ```go-html-template diff --git a/content/en/functions/resources/GetMatch.md b/content/en/functions/resources/GetMatch.md index 0ee86b977..83588378b 100644 --- a/content/en/functions/resources/GetMatch.md +++ b/content/en/functions/resources/GetMatch.md @@ -3,16 +3,11 @@ title: resources.GetMatch description: Returns the first global resource from paths matching the given glob pattern, or nil if none found. categories: [] keywords: [] -action: - aliases: [] - related: - - functions/resources/ByType - - functions/resources/Get - - functions/resources/GetRemote - - functions/resources/Match - - methods/page/Resources - returnType: resource.Resource - signatures: [resources.GetMatch PATTERN] +params: + functions_and_methods: + aliases: [] + returnType: resource.Resource + signatures: [resources.GetMatch PATTERN] --- ```go-html-template diff --git a/content/en/functions/resources/GetRemote.md b/content/en/functions/resources/GetRemote.md index 10a7641d8..e62ebbe02 100644 --- a/content/en/functions/resources/GetRemote.md +++ b/content/en/functions/resources/GetRemote.md @@ -3,18 +3,11 @@ title: resources.GetRemote description: Returns a remote resource from the given URL, or nil if none found. categories: [] keywords: [] -action: - aliases: [] - related: - - functions/data/GetCSV - - functions/data/GetJSON - - functions/resources/ByType - - functions/resources/Get - - functions/resources/GetMatch - - functions/resources/Match - - methods/page/Resources - returnType: resource.Resource - signatures: ['resources.GetRemote URL [OPTIONS]'] +params: + functions_and_methods: + aliases: [] + returnType: resource.Resource + signatures: ['resources.GetRemote URL [OPTIONS]'] --- {{< new-in 0.141.0 >}} diff --git a/content/en/functions/resources/Match.md b/content/en/functions/resources/Match.md index e6caa017e..eb6010515 100644 --- a/content/en/functions/resources/Match.md +++ b/content/en/functions/resources/Match.md @@ -3,16 +3,11 @@ title: resources.Match description: Returns a collection of global resources from paths matching the given glob pattern, or nil if none found. categories: [] keywords: [] -action: - aliases: [] - related: - - functions/resources/ByType - - functions/resources/Get - - functions/resources/GetMatch - - functions/resources/GetRemote - - methods/page/Resources - returnType: resource.Resources - signatures: [resources.Match PATTERN] +params: + functions_and_methods: + aliases: [] + returnType: resource.Resources + signatures: [resources.Match PATTERN] --- ```go-html-template diff --git a/content/en/functions/resources/Minify.md b/content/en/functions/resources/Minify.md index 25314fd6a..183e6671a 100644 --- a/content/en/functions/resources/Minify.md +++ b/content/en/functions/resources/Minify.md @@ -3,16 +3,11 @@ title: resources.Minify description: Minifies the given resource. categories: [] keywords: [] -action: - aliases: [minify] - related: - - functions/resources/Fingerprint - - functions/css/Sass - - functions/css/TailwindCSS - - functions/js/Build - - functions/js/Babel - returnType: resource.Resource - signatures: [resources.Minify RESOURCE] +params: + functions_and_methods: + aliases: [minify] + returnType: resource.Resource + signatures: [resources.Minify RESOURCE] --- ```go-html-template diff --git a/content/en/functions/resources/PostCSS.md b/content/en/functions/resources/PostCSS.md index faa328dc2..3ec0b84cf 100644 --- a/content/en/functions/resources/PostCSS.md +++ b/content/en/functions/resources/PostCSS.md @@ -3,10 +3,11 @@ title: resources.PostCSS description: Processes the given resource with PostCSS using any PostCSS plugin. categories: [] keywords: [] -action: - related: [] - returnType: resource.Resource - signatures: ['resources.PostCSS [OPTIONS] RESOURCE'] +params: + functions_and_methods: + aliases: [] + returnType: resource.Resource + signatures: ['resources.PostCSS [OPTIONS] RESOURCE'] expiryDate: 2026-06-24 # deprecated 2024-06-24 in v0.128.0 --- diff --git a/content/en/functions/resources/PostProcess.md b/content/en/functions/resources/PostProcess.md index c331f76b2..cebd7e4d9 100644 --- a/content/en/functions/resources/PostProcess.md +++ b/content/en/functions/resources/PostProcess.md @@ -3,13 +3,11 @@ title: resources.PostProcess description: Processes the given resource after the build. categories: [] keywords: [] -action: - aliases: [] - related: - - functions/css/PostCSS - - functions/css/Sass - returnType: postpub.PostPublishedResource - signatures: [resources.PostProcess RESOURCE] +params: + functions_and_methods: + aliases: [] + returnType: postpub.PostPublishedResource + signatures: [resources.PostProcess RESOURCE] --- The `resources.PostProcess` function delays resource transformation steps until the build is complete, primarily for tasks like removing unused CSS rules. diff --git a/content/en/functions/resources/ToCSS.md b/content/en/functions/resources/ToCSS.md index 8cbb7faff..7be1b8d45 100644 --- a/content/en/functions/resources/ToCSS.md +++ b/content/en/functions/resources/ToCSS.md @@ -3,10 +3,11 @@ title: resources.ToCSS description: Transpiles Sass to CSS. categories: [] keywords: [] -action: - related: [] - returnType: resource.Resource - signatures: ['resources.ToCSS [OPTIONS] RESOURCE'] +params: + functions_and_methods: + aliases: [] + returnType: resource.Resource + signatures: ['resources.ToCSS [OPTIONS] RESOURCE'] expiryDate: 2026-06-24 # deprecated 2024-06-24 in v0.128.0 ---