diff --git a/.cspell.json b/.cspell.json index 13865a83c..e9b15cc91 100644 --- a/.cspell.json +++ b/.cspell.json @@ -1,362 +1,129 @@ { "version": "0.2", - "words": [ - "aaabaab", - "aabb", - "aabba", - "aabbaa", - "aabbaabb", - "aabbaabbab", - "abbaa", - "abourget", - "absurl", - "adoc", - "algolia", - "allowfullscreen", - "ananke", - "anchorize", - "anthonyfok", - "asciidoctor", - "attrlink", - "azblob", - "baseof", - "bbaa", - "bcde", - "bcdef", - "beevelop", - "Bergevin", - "bibtex", - "Bjørn", - "blackfriday", - "blogue", - "bogem", - "Bootcamp", - "brlink", - "Brotli", - "Browsersync", - "canonicalization", - "canonify", - "Catmull", - "Catwoman", - "changefreq", - "Cheatsheet", - "choco", - "chromastyles", - "clockoon", - "Cloudinary", - "CNAME", - "Codecademy's", - "CODEOWNERS", - "Coen", - "Commento", - "Cond", - "contentdir", - "Contentful", - "Copr", - "copyrighthtml", - "corejs", - "countrunes", - "countwords", - "crossreferences", - "daftaupe", - "datatable", - "DATOCMS", - "debugconfig", - "defang", - "Deindent", - "DELIM", - "dhersam", - "digitalcraftsman", - "Disqus", - "Dmdh", - "doas", - "dokuwiki", - "dpkg", - "DRING", - "Eiqc", - "Eliott", - "embeddable", - "Emojify", - "Enwrite", - "eopkg", - "eparis", - "errorf", - "erroridf", - "esbuild", - "Evernote", - "Exif", - "exitwp", - "expirydate", - "Feminella", - "firstpost", - "Flickr", - "Formspree", - "fpath", - "Francia", - "freenode", - "frontmatter", - "funcs", - "funcsig", - "Garen", - "Garuda", - "gcloud", - "Getenv", - "getjson", - "getpage", - "Gitee", - "Gmfc", - "Goel", - "Gohugo", - "gohugoio", - "goldenbridge", - "Goldmark", - "gomodules", - "GOPATH", - "govendor", - "Gowans", - "Grayscale", - "Gregor", - "Gruber", - "gtag", - "gvfs", - "hidecaption", - "hmac", - "Hokus", - "hola", - "hügó", - "hugodeps", - "hugodoc", - "Hugofy", - "hugolang", - "hugoversion", - "Hyas", - "Hyvor", - "iframes", - "ifttt", - "iife", - "imgproc", - "importr", - "IMWQ", - "indice", - "innershortcode", - "Intelli", - "interdoc", - "IPTC", - "ismenucurrent", - "Isset", - "Isso", - "Jaco", - "JIRN", - "johnpatitucci", - "Joomla", - "JRBR", - "jsonify", - "Karmada", - "katex", - "keycdn", - "KEYVALS", - "kubernetes", - "Kubuntu", - "Lanczos", - "langformatnumber", - "lastmod", - "libwebp", - "linktitle", - "Lipi", - "lrwxr", - "Lubuntu", - "maingo", - "markdownified", - "markdownify", - "mathjax", - "mdhender", - "mdshortcode", - "MENUENTRY", - "mercredi", - "Milli", - "Mittwoch", - "mkdir", - "modh", - "monokai", - "Morling", - "mspowerpoint", - "Multihost", - "Muut", - "myclass", - "mydeployment", - "myindex", - "mylayout", - "mylogin", - "mypage", - "mypartials", - "mypost", - "mysite", - "myspa", - "mystyle", - "mytextpartial", - "mytheme", - "NDJSON", - "needsexample", - "Netravali", - "newparam", - "Nichlas", - "Nikhil", - "Nikola", - "Njjy", - "nlist", - "nobr", - "nocopy", - "Norsk", - "nosniff", - "NOSQL", - "notoc", - "novembre", - "numfmt", - "NUMWORKERMULTIPLIER", - "Obhu", - "octohug", - "Octopress", - "oldparam", - "onrender", - "opengraph", - "OWASP", - "Pandoc", - "partialcached", - "Pastorius", - "Patitucci", - "PCRE", - "peaceiris", - "Pedersen", - "Pekka", - "permalinkable", - "plainify", - "POSIX", - "postprocess", - "Poupin", - "prerender", - "println", - "Pritchard", - "publishdate", - "Pygments", - "qref", - "querify", - "QVOMC", - "Racic", - "Rclone", - "rdwatters", - "readfile", - "rebinded", - "recommendedby", - "REDIR", - "reftext", - "relatedfuncs", - "relref", - "relurl", - "remarkjs", - "rgba", - "Riku", - "rlimit", - "roboto", - "rssxml", - "rwxrwxrwx", - "RYUGV", - "safehtml", - "safejs", - "Samsa", - "schemaorg", - "setx", - "Shekhar", - "Shortcode", - "Shortcodes", - "signup", - "Silvola", - "Sindre", - "sitemapindex", - "sitemapxml", - "slugorfilename", - "Smartcrop", - "Sobre", - "Sprintf", - "Startseite", - "strconv", - "stringifier", - "struct", - "structs", - "subdir", - "svgs", - "symdiff", - "Talkyard", - "taxo", - "taxonomyname", - "tbody", - "tdewolff", - "testshortcodes", - "thead", - "Thinkful", - "Tknx", - "TLDR", - "TMPDIR", - "toclevels", - "TOCSS", - "todos", - "tojson", - "Tomango", - "topologix", - "Torikian", - "totoml", - "toyaml", - "twitteruser", - "Unmarshal", - "unpublishdate", - "Unsharp", - "urlize", - "urlset", - "utimestamp", - "vendored", - "vimrc", - "wanghc", - "Wappalyzer", - "warnf", - "webp", - "Wercker", - "wibble", - "wordcount", - "workson", - "Wowchemy", - "wpxr", - "Xbaabbab", - "Xubuntu", - "xvzf", - "yoyoyo", - "yunbox", - "Zgotmpl", - "Zorin", - "zzbbaabb", - "مدونتي" - ], - "language": "en,en-US,de,fr", - "allowCompoundWords": false, + "allowCompoundWords": true, "files": [ "**/*.md" ], - "ignoreRegExpList": [ - "\\n(`{3,})\\w*\\n[\\s\\S]+?\\1", - "\\[(\\*{2})?@\\w+?\\1\\]", - "\\[`\\w+`\\]", - "ve{2,}r{2,}y", - "ve+r+y+long\\w*", - "\\/.*?\\/", - "\\_\\w+", - "\\#\\w+" + "flagWords": [ + "alot", + "hte", + "reccommend", + "seperate" ], "ignorePaths": [ - ".cspell.json", - "**/node_modules/**", - "*.min.*", - "**/news/*", + "**/emojis.md", + "**/commands/*", "**/showcase/*", - "**/content-management/emoji-shortcodes.md" + "**/tools/*" ], - "useGitignore": true, - "enabled": true + "ignoreRegExpList": [ + "# cspell: ignore fenced code blocks", + "^(\\s*`{3,}).*[\\s\\S]*?^\\1", + "# cspell: ignore words joined with dot", + "\\w+\\.\\w+", + "# cspell: ignore strings within backticks", + "`.+`", + "# cspell: ignore strings within single quotes", + "'.+'", + "# cspell: ignore strings within double quotes", + "\".+\"", + "# cspell: ignore strings within brackets", + "\\[.+\\]", + "# cspell: ignore strings within parentheses", + "\\(.+\\)", + "# cspell: ignore words that begin with a slash", + "/\\w+", + "# cspell: ignore everything within action delimiters", + "\\{\\{.+\\}\\}", + "# cspell: ignore everything after a right arrow", + "\\s+→\\s+.+" + ], + "language": "en", + "words": [ + "antialiasing", + "codeowners", + "composability", + "configurators", + "defang", + "deindent", + "downscale", + "downscaled", + "downscaling", + "exif", + "geolocalized", + "grayscale", + "marshal", + "marshaling", + "multihost", + "performantly", + "preconfigured", + "prerendering", + "redirection", + "redirections", + "shortcode", + "shortcodes", + "subexpression", + "subexpressions", + "suppressable", + "templating", + "transpile", + "transpiles", + "unmarshal", + "unmarshaling", + "# ----------------------------------------------------------------------", + "# cspell: ignore foreign language words", + "# ----------------------------------------------------------------------", + "bezpieczeństwo", + "dokumentation", + "libros", + "miesiąc", + "miesiąc", + "miesięcy", + "miesięcy", + "misérables", + "projekt", + "régime", + "# ----------------------------------------------------------------------", + "# cspell: ignore proper nouns", + "# ----------------------------------------------------------------------", + "Eliott", + "Gregor", + "Jaco", + "Noll", + "Pastorius", + "Samsa", + "# ----------------------------------------------------------------------", + "# cspell: ignore operating systems and software packages", + "# ----------------------------------------------------------------------", + "asciidoctor", + "brotli", + "corejs", + "disqus", + "doas", + "eopkg", + "gitee", + "goldmark", + "kubuntu", + "lubuntu", + "nosql", + "pandoc", + "pkgin", + "rclone", + "xubuntu", + "# ----------------------------------------------------------------------", + "# cspell: ignore miscellaneous", + "# ----------------------------------------------------------------------", + "dring", + "getenv", + "gohugo", + "jdoe", + "milli", + "rgba", + "rsmith", + "stringifier", + "struct", + "tjones", + "toclevels", + "vals" + ] } diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml index aa3ee25e7..a650f153c 100644 --- a/.github/workflows/spellcheck.yml +++ b/.github/workflows/spellcheck.yml @@ -1,9 +1,9 @@ name: "Check spelling" -on: # rebuild any PRs and main branch changes +on: push: + pull_request: branches-ignore: - "dependabot/**" - pull_request: permissions: contents: read @@ -16,6 +16,7 @@ jobs: - uses: streetsidesoftware/cspell-action@v4 with: check_dot_files: false + files: content/**/*.md incremental_files_only: true inline: warning strict: false diff --git a/content/en/content-management/formats.md b/content/en/content-management/formats.md index 62124de2a..76c8102b5 100644 --- a/content/en/content-management/formats.md +++ b/content/en/content-management/formats.md @@ -24,12 +24,12 @@ The current list of content formats in Hugo: | Name | Markup identifiers | Comment | | ------------- | ------------- |-------------| -| Goldmark | markdown, goldmark |Note that you can set the default handler of `md` and `markdown` to something else, see [Configure Markup](/getting-started/configuration-markup/).| -|Emacs Org-Mode|org|See [go-org](https://github.com/niklasfasching/go-org).| -|AsciiDoc|asciidocext, adoc, ad|Needs [Asciidoctor][ascii] installed.| -|RST|rst|Needs [RST](https://docutils.sourceforge.io/rst.html) installed.| -|Pandoc|pandoc, pdc|Needs [Pandoc](https://www.pandoc.org/) installed.| -|HTML|html, htm|To be treated as a content file, with layout, shortcodes etc., it must have front matter. If not, it will be copied as-is.| +| Goldmark | `markdown`, `goldmark` |Note that you can set the default handler of `md` and `markdown` to something else, see [Configure Markup](/getting-started/configuration-markup/).| +|Emacs Org-Mode|`org`|See [go-org](https://github.com/niklasfasching/go-org).| +|AsciiDoc|`asciidocext`, `adoc`, `ad`|Needs [Asciidoctor][ascii] installed.| +|RST|`rst`|Needs [RST](https://docutils.sourceforge.io/rst.html) installed.| +|Pandoc|`pandoc`, `pdc`|Needs [Pandoc](https://www.pandoc.org/) installed.| +|HTML|`html`, `htm`|To be treated as a content file, with layout, shortcodes etc., it must have front matter. If not, it will be copied as-is.| The `markup identifier` is fetched from either the `markup` variable in front matter or from the file extension. For markup-related configuration, see [Configure Markup](/getting-started/configuration-markup/). diff --git a/content/en/content-management/image-processing/index.md b/content/en/content-management/image-processing/index.md index d5eb33ff8..9e6431261 100644 --- a/content/en/content-management/image-processing/index.md +++ b/content/en/content-management/image-processing/index.md @@ -105,7 +105,7 @@ Example 4: Skips rendering if there's problem accessing a remote resource. The `image` resource implements the [`Process`], [`Resize`], [`Fit`], [`Fill`], [`Crop`], [`Filter`], [`Colors`] and [`Exif`] methods. {{% note %}} -Metadata (EXIF, IPTC, XMP, etc.) is not preserved during image transformation. Use the [`Exif`] method with the _original_ image to extract EXIF metadata from JPEG or TIFF images. +Metadata (EXIF, IPTC, XMP, etc.) is not preserved during image transformation. Use the `Exif` method with the _original_ image to extract EXIF metadata from JPEG or TIFF images. {{% /note %}} ### Process diff --git a/content/en/contribute/development.md b/content/en/contribute/development.md index 2136b1692..1ee869374 100644 --- a/content/en/contribute/development.md +++ b/content/en/contribute/development.md @@ -326,7 +326,7 @@ git rebase --interactive @~6 The `6` at the end of the command represents the number of commits that should be modified. An editor should open and present a list of last six commit messages: ```txt -pick 80d02a1 tpl: Add hasPrefix to the template funcs' "smoke test" +pick 80d02a1 tpl: Add hasPrefix to template function smoke test" pick aaee038 tpl: Sort the smoke tests pick f0dbf2c tpl: Add the other test case for hasPrefix pick 911c35b Add "How to contribute to Hugo" tutorial @@ -339,7 +339,7 @@ In the case above we should merge the last two commits in the commit of this tut All operations are written before the commit message. Replace "pick" with an operation. In this case `squash` or `s` for short: ```txt -pick 80d02a1 tpl: Add hasPrefix to the template funcs' "smoke test" +pick 80d02a1 tpl: Add hasPrefix to template function smoke test" pick aaee038 tpl: Sort the smoke tests pick f0dbf2c tpl: Add the other test case for hasPrefix pick 911c35b Add "How to contribute to Hugo" tutorial @@ -352,7 +352,7 @@ We also want to rewrite the commits message of the third last commit. We forgot You should end up with a similar setup: ```txt -pick 80d02a1 tpl: Add hasPrefix to the template funcs' "smoke test" +pick 80d02a1 tpl: Add hasPrefix to template function smoke test" pick aaee038 tpl: Sort the smoke tests pick f0dbf2c tpl: Add the other test case for hasPrefix reword 911c35b Add "How to contribute to Hugo" tutorial diff --git a/content/en/functions/collections/KeyVals.md b/content/en/functions/collections/KeyVals.md index 6019ede51..3d21ca6fd 100644 --- a/content/en/functions/collections/KeyVals.md +++ b/content/en/functions/collections/KeyVals.md @@ -38,7 +38,6 @@ The resulting data structure is: To extract the key and values: ```go-html-template - {{ $kv.Key }} → foo {{ $kv.Values }} → [a b c] ``` diff --git a/content/en/functions/data/GetCSV.md b/content/en/functions/data/GetCSV.md index b49f190e3..d61ea791d 100644 --- a/content/en/functions/data/GetCSV.md +++ b/content/en/functions/data/GetCSV.md @@ -95,8 +95,6 @@ my-project/ Consider using the [`Resources.Get`] method with [`transform.Unmarshal`] when accessing a page resource. - - ```text my-project/ └── content/ diff --git a/content/en/functions/hugo/_index.md b/content/en/functions/hugo/_index.md index e13c12b33..c3ad686da 100644 --- a/content/en/functions/hugo/_index.md +++ b/content/en/functions/hugo/_index.md @@ -9,4 +9,4 @@ menu: parent: functions --- -Use these functions to access information about the Hugo application and the current environment. +Use these functions to access information about the Hugo application and the current environment. diff --git a/content/en/functions/images/Overlay.md b/content/en/functions/images/Overlay.md index f04e3668b..39e62b121 100644 --- a/content/en/functions/images/Overlay.md +++ b/content/en/functions/images/Overlay.md @@ -1,6 +1,6 @@ --- title: images.Overlay -description: Returns an image filter that overlays the source image at the given coordinates. +description: Returns an image filter that overlays the source image at the given coordinates, relative to the upper left corner. categories: [] keywords: [] action: @@ -13,8 +13,6 @@ action: toc: true --- -The coordinates are relative to the upper left corner. - ## Usage Capture the overlay image as a resource: diff --git a/content/en/functions/js/Build.md b/content/en/functions/js/Build.md index e3b40a2ac..e679dfbf7 100644 --- a/content/en/functions/js/Build.md +++ b/content/en/functions/js/Build.md @@ -45,7 +45,7 @@ targetPath : (`string`) If not set, the source path will be used as the base target path. Note that the target path's extension may change if the target MIME type is different, e.g. when the source is TypeScript. -params [map or slice] +params : (`map` or `slice`) Params that can be imported as JSON in your JS files, e.g. ```go-html-template diff --git a/content/en/functions/strings/Split.md b/content/en/functions/strings/Split.md index dba50090c..a9973ea63 100644 --- a/content/en/functions/strings/Split.md +++ b/content/en/functions/strings/Split.md @@ -1,6 +1,6 @@ --- title: strings.Split -description: Returns a slice of strings by splitting STRING by DELIM. +description: Returns a slice of strings by splitting the given string by a delimiter. categories: [] keywords: [] action: diff --git a/content/en/hosting-and-deployment/hosting-on-firebase.md b/content/en/hosting-and-deployment/hosting-on-firebase.md index 6625bf918..028964bcf 100644 --- a/content/en/hosting-and-deployment/hosting-on-firebase.md +++ b/content/en/hosting-and-deployment/hosting-on-firebase.md @@ -1,6 +1,6 @@ --- title: Host on Firebase -description: You can use Firebase's free tier to host your static website; this also gives you access to Firebase's NOSQL API. +description: You can use Firebase's free tier to host your static website; this also gives you access to Firebase's NoSQL API. categories: [hosting and deployment] keywords: [hosting,firebase] menu: diff --git a/content/en/hosting-and-deployment/hosting-on-netlify.md b/content/en/hosting-and-deployment/hosting-on-netlify.md index 9b3dbd88b..acdecf9b2 100644 --- a/content/en/hosting-and-deployment/hosting-on-netlify.md +++ b/content/en/hosting-and-deployment/hosting-on-netlify.md @@ -19,7 +19,7 @@ toc: true ## Create a Netlify account -Go to [app.netlify.com] and select your preferred signup method. This will likely be a hosted Git provider, although you also have the option to sign up with an email address. +Go to [app.netlify.com] and select your preferred sign up method. This will likely be a hosted Git provider, although you also have the option to sign up with an email address. The following examples use GitHub, but other git providers will follow a similar process. diff --git a/content/en/hugo-pipes/babel.md b/content/en/hugo-pipes/babel.md index ffe2ed002..73ccf01d4 100755 --- a/content/en/hugo-pipes/babel.md +++ b/content/en/hugo-pipes/babel.md @@ -8,7 +8,7 @@ menu: parent: hugo-pipes weight: 70 weight: 70 -action: +function: aliases: [babel] returnType: resource.Resource signatures: ['resources.Babel [OPTIONS] RESOURCE'] @@ -44,23 +44,23 @@ module.exports = { ### Options -config [string] -: Path to the Babel configuration file. Hugo will, by default, look for a `babel.config.js` in your project. More information on these configuration files can be found here: [babel configuration](https://babeljs.io/docs/en/configuration). +config +: (`string`) Path to the Babel configuration file. Hugo will, by default, look for a `babel.config.js` in your project. More information on these configuration files can be found here: [babel configuration](https://babeljs.io/docs/en/configuration). -minified [bool] -: Save as many bytes as possible when printing +minified +: (`bool`) Save as many bytes as possible when printing -noComments [bool] -: Write comments to generated output (true by default) +noComments +: (`bool`) Write comments to generated output (true by default) -compact [bool] -: Do not include superfluous whitespace characters and line terminators. Defaults to `auto` if not set. +compact +: (`bool`) Do not include superfluous whitespace characters and line terminators. Defaults to `auto` if not set. -verbose [bool] -: Log everything +verbose +: (`bool`) Log everything -sourceMap [string] -: Output `inline` or `external` sourcemap from the babel compile. External sourcemaps will be written to the target with the output file name + ".map". Input sourcemaps can be read from js.Build and node modules and combined into the output sourcemaps. +sourceMap +: (`string`) Output `inline` or `external` sourcemap from the babel compile. External sourcemaps will be written to the target with the output file name + ".map". Input sourcemaps can be read from js.Build and node modules and combined into the output sourcemaps. ### Examples diff --git a/content/en/hugo-pipes/js.md b/content/en/hugo-pipes/js.md index d4f07595e..3934026ed 100644 --- a/content/en/hugo-pipes/js.md +++ b/content/en/hugo-pipes/js.md @@ -1,7 +1,7 @@ --- title: js.Build linkTitle: JavaScript building -description: Process a JavaScript file with [ESBuild](https://github.com/evanw/esbuild). +description: Bundle, transpile, tree shake, and minify JavaScript resources. categories: [asset management] keywords: [] menu: @@ -21,12 +21,12 @@ Any JavaScript resource file can be transpiled and "tree shaken" using `js.Build ### Options -targetPath [string] -: If not set, the source path will be used as the base target path. +targetPath +: (`string`) If not set, the source path will be used as the base target path. Note that the target path's extension may change if the target MIME type is different, e.g. when the source is TypeScript. -params [map or slice] -: Params that can be imported as JSON in your JS files, e.g.: +params +: (`map` or `slice`) Params that can be imported as JSON in your JS files, e.g.: ```go-html-template {{ $js := resources.Get "js/main.js" | js.Build (dict "params" (dict "api" "https://example.org/api")) }} @@ -39,14 +39,14 @@ import * as params from '@params'; Note that this is meant for small data sets, e.g. configuration settings. For larger data, please put/mount the files into `/assets` and import them directly. -minify [bool] -: Let `js.Build` handle the minification. +minify +: (`bool`) Let `js.Build` handle the minification. -inject [slice] -: This option allows you to automatically replace a global variable with an import from another file. The path names must be relative to `assets`. See https://esbuild.github.io/api/#inject +inject +: (`slice`) This option allows you to automatically replace a global variable with an import from another file. The path names must be relative to `assets`. See https://esbuild.github.io/api/#inject -shims [map] -: This option allows swapping out a component with another. A common use case is to load dependencies like React from a CDN (with _shims_) when in production, but running with the full bundled `node_modules` dependency during development: +shims +: (`map`) This option allows swapping out a component with another. A common use case is to load dependencies like React from a CDN (with _shims_) when in production, but running with the full bundled `node_modules` dependency during development: ```go-html-template {{ $shims := dict "react" "js/shims/react.js" "react-dom" "js/shims/react-dom.js" }} @@ -72,28 +72,28 @@ import * as React from 'react' import * as ReactDOM from 'react-dom'; ``` -target [string] -: The language target. +target +: (`string`) The language target. One of: `es5`, `es2015`, `es2016`, `es2017`, `es2018`, `es2019`, `es2020` or `esnext`. Default is `esnext`. -externals [slice] -: External dependencies. Use this to trim dependencies you know will never be executed. See https://esbuild.github.io/api/#external +externals +: (`slice`) External dependencies. Use this to trim dependencies you know will never be executed. See https://esbuild.github.io/api/#external -defines [map] -: Allow to define a set of string replacement to be performed when building. Should be a map where each key is to be replaced by its value. +defines +: (`map`) Allow to define a set of string replacement to be performed when building. Should be a map where each key is to be replaced by its value. ```go-html-template {{ $defines := dict "process.env.NODE_ENV" `"development"` }} ``` -format [string] -: The output format. +format +: (`string`) The output format. One of: `iife`, `cjs`, `esm`. Default is `iife`, a self-executing function, suitable for inclusion as a