mirror of
https://github.com/gohugoio/hugoDocs.git
synced 2025-08-04 04:58:55 -04:00
Miscellaneous updates
This commit is contained in:
Joe Mooring
GitHub
parent
80b2241f9e
commit
508666575f
471
.cspell.json
471
.cspell.json
@ -1,362 +1,129 @@
|
|||||||
{
|
{
|
||||||
"version": "0.2",
|
"version": "0.2",
|
||||||
"words": [
|
"allowCompoundWords": true,
|
||||||
"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,
|
|
||||||
"files": [
|
"files": [
|
||||||
"**/*.md"
|
"**/*.md"
|
||||||
],
|
],
|
||||||
"ignoreRegExpList": [
|
"flagWords": [
|
||||||
"<!-- prettier-ignore -->\\n(`{3,})\\w*\\n[\\s\\S]+?\\1",
|
"alot",
|
||||||
"\\[(\\*{2})?@\\w+?\\1\\]",
|
"hte",
|
||||||
"\\[`\\w+`\\]",
|
"reccommend",
|
||||||
"ve{2,}r{2,}y",
|
"seperate"
|
||||||
"ve+r+y+long\\w*",
|
|
||||||
"\\/.*?\\/",
|
|
||||||
"\\_\\w+",
|
|
||||||
"\\#\\w+"
|
|
||||||
],
|
],
|
||||||
"ignorePaths": [
|
"ignorePaths": [
|
||||||
".cspell.json",
|
"**/emojis.md",
|
||||||
"**/node_modules/**",
|
"**/commands/*",
|
||||||
"*.min.*",
|
|
||||||
"**/news/*",
|
|
||||||
"**/showcase/*",
|
"**/showcase/*",
|
||||||
"**/content-management/emoji-shortcodes.md"
|
"**/tools/*"
|
||||||
],
|
],
|
||||||
"useGitignore": true,
|
"ignoreRegExpList": [
|
||||||
"enabled": true
|
"# 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"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
5
.github/workflows/spellcheck.yml
vendored
5
.github/workflows/spellcheck.yml
vendored
@ -1,9 +1,9 @@
|
|||||||
name: "Check spelling"
|
name: "Check spelling"
|
||||||
on: # rebuild any PRs and main branch changes
|
on:
|
||||||
push:
|
push:
|
||||||
|
pull_request:
|
||||||
branches-ignore:
|
branches-ignore:
|
||||||
- "dependabot/**"
|
- "dependabot/**"
|
||||||
pull_request:
|
|
||||||
|
|
||||||
permissions:
|
permissions:
|
||||||
contents: read
|
contents: read
|
||||||
@ -16,6 +16,7 @@ jobs:
|
|||||||
- uses: streetsidesoftware/cspell-action@v4
|
- uses: streetsidesoftware/cspell-action@v4
|
||||||
with:
|
with:
|
||||||
check_dot_files: false
|
check_dot_files: false
|
||||||
|
files: content/**/*.md
|
||||||
incremental_files_only: true
|
incremental_files_only: true
|
||||||
inline: warning
|
inline: warning
|
||||||
strict: false
|
strict: false
|
||||||
|
|||||||
@ -24,12 +24,12 @@ The current list of content formats in Hugo:
|
|||||||
|
|
||||||
| Name | Markup identifiers | Comment |
|
| 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/).|
|
| 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).|
|
|Emacs Org-Mode|`org`|See [go-org](https://github.com/niklasfasching/go-org).|
|
||||||
|AsciiDoc|asciidocext, adoc, ad|Needs [Asciidoctor][ascii] installed.|
|
|AsciiDoc|`asciidocext`, `adoc`, `ad`|Needs [Asciidoctor][ascii] installed.|
|
||||||
|RST|rst|Needs [RST](https://docutils.sourceforge.io/rst.html) installed.|
|
|RST|`rst`|Needs [RST](https://docutils.sourceforge.io/rst.html) installed.|
|
||||||
|Pandoc|pandoc, pdc|Needs [Pandoc](https://www.pandoc.org/) 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.|
|
|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/).
|
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/).
|
||||||
|
|
||||||
|
|||||||
@ -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.
|
The `image` resource implements the [`Process`], [`Resize`], [`Fit`], [`Fill`], [`Crop`], [`Filter`], [`Colors`] and [`Exif`] methods.
|
||||||
|
|
||||||
{{% note %}}
|
{{% 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 %}}
|
{{% /note %}}
|
||||||
|
|
||||||
### Process
|
### Process
|
||||||
|
|||||||
@ -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:
|
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
|
```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 aaee038 tpl: Sort the smoke tests
|
||||||
pick f0dbf2c tpl: Add the other test case for hasPrefix
|
pick f0dbf2c tpl: Add the other test case for hasPrefix
|
||||||
pick 911c35b Add "How to contribute to Hugo" tutorial
|
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:
|
All operations are written before the commit message. Replace "pick" with an operation. In this case `squash` or `s` for short:
|
||||||
|
|
||||||
```txt
|
```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 aaee038 tpl: Sort the smoke tests
|
||||||
pick f0dbf2c tpl: Add the other test case for hasPrefix
|
pick f0dbf2c tpl: Add the other test case for hasPrefix
|
||||||
pick 911c35b Add "How to contribute to Hugo" tutorial
|
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:
|
You should end up with a similar setup:
|
||||||
|
|
||||||
```txt
|
```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 aaee038 tpl: Sort the smoke tests
|
||||||
pick f0dbf2c tpl: Add the other test case for hasPrefix
|
pick f0dbf2c tpl: Add the other test case for hasPrefix
|
||||||
reword 911c35b Add "How to contribute to Hugo" tutorial
|
reword 911c35b Add "How to contribute to Hugo" tutorial
|
||||||
|
|||||||
@ -38,7 +38,6 @@ The resulting data structure is:
|
|||||||
To extract the key and values:
|
To extract the key and values:
|
||||||
|
|
||||||
```go-html-template
|
```go-html-template
|
||||||
|
|
||||||
{{ $kv.Key }} → foo
|
{{ $kv.Key }} → foo
|
||||||
{{ $kv.Values }} → [a b c]
|
{{ $kv.Values }} → [a b c]
|
||||||
```
|
```
|
||||||
|
|||||||
@ -95,8 +95,6 @@ my-project/
|
|||||||
|
|
||||||
Consider using the [`Resources.Get`] method with [`transform.Unmarshal`] when accessing a page resource.
|
Consider using the [`Resources.Get`] method with [`transform.Unmarshal`] when accessing a page resource.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
```text
|
```text
|
||||||
my-project/
|
my-project/
|
||||||
└── content/
|
└── content/
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: images.Overlay
|
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: []
|
categories: []
|
||||||
keywords: []
|
keywords: []
|
||||||
action:
|
action:
|
||||||
@ -13,8 +13,6 @@ action:
|
|||||||
toc: true
|
toc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
The coordinates are relative to the upper left corner.
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Capture the overlay image as a resource:
|
Capture the overlay image as a resource:
|
||||||
|
|||||||
@ -45,7 +45,7 @@ targetPath
|
|||||||
: (`string`) If not set, the source path will be used as the base target path.
|
: (`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.
|
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.
|
: (`map` or `slice`) Params that can be imported as JSON in your JS files, e.g.
|
||||||
|
|
||||||
```go-html-template
|
```go-html-template
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: strings.Split
|
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: []
|
categories: []
|
||||||
keywords: []
|
keywords: []
|
||||||
action:
|
action:
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Host on Firebase
|
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]
|
categories: [hosting and deployment]
|
||||||
keywords: [hosting,firebase]
|
keywords: [hosting,firebase]
|
||||||
menu:
|
menu:
|
||||||
|
|||||||
@ -8,7 +8,7 @@ menu:
|
|||||||
parent: hugo-pipes
|
parent: hugo-pipes
|
||||||
weight: 70
|
weight: 70
|
||||||
weight: 70
|
weight: 70
|
||||||
action:
|
function:
|
||||||
aliases: [babel]
|
aliases: [babel]
|
||||||
returnType: resource.Resource
|
returnType: resource.Resource
|
||||||
signatures: ['resources.Babel [OPTIONS] RESOURCE']
|
signatures: ['resources.Babel [OPTIONS] RESOURCE']
|
||||||
@ -44,23 +44,23 @@ module.exports = {
|
|||||||
|
|
||||||
### Options
|
### Options
|
||||||
|
|
||||||
config [string]
|
config
|
||||||
: 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).
|
: (`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]
|
minified
|
||||||
: Save as many bytes as possible when printing
|
: (`bool`) Save as many bytes as possible when printing
|
||||||
|
|
||||||
noComments [bool]
|
noComments
|
||||||
: Write comments to generated output (true by default)
|
: (`bool`) Write comments to generated output (true by default)
|
||||||
|
|
||||||
compact [bool]
|
compact
|
||||||
: Do not include superfluous whitespace characters and line terminators. Defaults to `auto` if not set.
|
: (`bool`) Do not include superfluous whitespace characters and line terminators. Defaults to `auto` if not set.
|
||||||
|
|
||||||
verbose [bool]
|
verbose
|
||||||
: Log everything
|
: (`bool`) Log everything
|
||||||
|
|
||||||
sourceMap [string]
|
sourceMap
|
||||||
: 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.
|
: (`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
|
### Examples
|
||||||
|
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
title: js.Build
|
title: js.Build
|
||||||
linkTitle: JavaScript building
|
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]
|
categories: [asset management]
|
||||||
keywords: []
|
keywords: []
|
||||||
menu:
|
menu:
|
||||||
@ -21,12 +21,12 @@ Any JavaScript resource file can be transpiled and "tree shaken" using `js.Build
|
|||||||
|
|
||||||
### Options
|
### Options
|
||||||
|
|
||||||
targetPath [string]
|
targetPath
|
||||||
: If not set, the source path will be used as the base target path.
|
: (`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.
|
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
|
||||||
: Params that can be imported as JSON in your JS files, e.g.:
|
: (`map` or `slice`) Params that can be imported as JSON in your JS files, e.g.:
|
||||||
|
|
||||||
```go-html-template
|
```go-html-template
|
||||||
{{ $js := resources.Get "js/main.js" | js.Build (dict "params" (dict "api" "https://example.org/api")) }}
|
{{ $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.
|
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]
|
minify
|
||||||
: Let `js.Build` handle the minification.
|
: (`bool`) Let `js.Build` handle the minification.
|
||||||
|
|
||||||
inject [slice]
|
inject
|
||||||
: 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
|
: (`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]
|
shims
|
||||||
: 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:
|
: (`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
|
```go-html-template
|
||||||
{{ $shims := dict "react" "js/shims/react.js" "react-dom" "js/shims/react-dom.js" }}
|
{{ $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';
|
import * as ReactDOM from 'react-dom';
|
||||||
```
|
```
|
||||||
|
|
||||||
target [string]
|
target
|
||||||
: The language target.
|
: (`string`) The language target.
|
||||||
One of: `es5`, `es2015`, `es2016`, `es2017`, `es2018`, `es2019`, `es2020` or `esnext`.
|
One of: `es5`, `es2015`, `es2016`, `es2017`, `es2018`, `es2019`, `es2020` or `esnext`.
|
||||||
Default is `esnext`.
|
Default is `esnext`.
|
||||||
|
|
||||||
externals [slice]
|
externals
|
||||||
: External dependencies. Use this to trim dependencies you know will never be executed. See https://esbuild.github.io/api/#external
|
: (`slice`) External dependencies. Use this to trim dependencies you know will never be executed. See https://esbuild.github.io/api/#external
|
||||||
|
|
||||||
defines [map]
|
defines
|
||||||
: 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.
|
: (`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
|
```go-html-template
|
||||||
{{ $defines := dict "process.env.NODE_ENV" `"development"` }}
|
{{ $defines := dict "process.env.NODE_ENV" `"development"` }}
|
||||||
```
|
```
|
||||||
|
|
||||||
format [string]
|
format
|
||||||
: The output format.
|
: (`string`) The output format.
|
||||||
One of: `iife`, `cjs`, `esm`.
|
One of: `iife`, `cjs`, `esm`.
|
||||||
Default is `iife`, a self-executing function, suitable for inclusion as a <script> tag.
|
Default is `iife`, a self-executing function, suitable for inclusion as a <script> tag.
|
||||||
|
|
||||||
sourceMap [string]
|
sourceMap
|
||||||
: Whether to generate `inline` or `external` source maps from esbuild. External source maps will be written to the target with the output file name + ".map". Input source maps can be read from js.Build and node modules and combined into the output source maps. By default, source maps are not created.
|
: (`string`) Whether to generate `inline` or `external` source maps from esbuild. External source maps will be written to the target with the output file name + ".map". Input source maps can be read from js.Build and node modules and combined into the output source maps. By default, source maps are not created.
|
||||||
|
|
||||||
### Import JS code from /assets
|
### Import JS code from /assets
|
||||||
|
|
||||||
|
|||||||
@ -23,8 +23,8 @@ With this content structure:
|
|||||||
```text
|
```text
|
||||||
content/
|
content/
|
||||||
├── auctions/
|
├── auctions/
|
||||||
│ ├── 2023-11/ <-- front matter: weight = 202311
|
│ ├── 2023-11/
|
||||||
│ │ ├── _index.md
|
│ │ ├── _index.md <-- front matter: weight = 202311
|
||||||
│ │ ├── auction-1.md
|
│ │ ├── auction-1.md
|
||||||
│ │ └── auction-2.md
|
│ │ └── auction-2.md
|
||||||
│ ├── 2023-12/
|
│ ├── 2023-12/
|
||||||
|
|||||||
@ -23,8 +23,8 @@ With this content structure:
|
|||||||
```text
|
```text
|
||||||
content/
|
content/
|
||||||
├── auctions/
|
├── auctions/
|
||||||
│ ├── 2023-11/ <-- front matter: weight = 202311
|
│ ├── 2023-11/
|
||||||
│ │ ├── _index.md
|
│ │ ├── _index.md <-- front matter: weight = 202311
|
||||||
│ │ ├── auction-1.md
|
│ │ ├── auction-1.md
|
||||||
│ │ └── auction-2.md
|
│ │ └── auction-2.md
|
||||||
│ ├── 2023-12/
|
│ ├── 2023-12/
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Exif
|
title: Exif
|
||||||
description: Applicable to images, returns an EXIF object containing image metatdata.
|
description: Applicable to images, returns an EXIF object containing image metadata.
|
||||||
categories: []
|
categories: []
|
||||||
keywords: []
|
keywords: []
|
||||||
action:
|
action:
|
||||||
@ -10,7 +10,7 @@ action:
|
|||||||
toc: true
|
toc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
Applicable to images, the `Exif` method on an image `Resource` object returns an [EXIF] object containing image metatdata.
|
Applicable to images, the `Exif` method on an image `Resource` object returns an [EXIF] object containing image metadata.
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
|
|||||||
@ -15,7 +15,7 @@ The `Scratch` method within a shortcode creates a [scratch pad] to store and man
|
|||||||
{{% note %}}
|
{{% note %}}
|
||||||
With the introduction of the [`newScratch`] function, and the ability to [assign values to template variables] after initialization, the `Scratch` method within a shortcode is obsolete.
|
With the introduction of the [`newScratch`] function, and the ability to [assign values to template variables] after initialization, the `Scratch` method within a shortcode is obsolete.
|
||||||
|
|
||||||
[assign values to variables]: https://go.dev/doc/go1.11#text/template
|
[assign values to template variables]: https://go.dev/doc/go1.11#text/template
|
||||||
[`newScratch`]: functions/collections/newscratch
|
[`newScratch`]: functions/collections/newscratch
|
||||||
{{% /note %}}
|
{{% /note %}}
|
||||||
|
|
||||||
|
|||||||
@ -6,8 +6,8 @@ keywords: [emoji]
|
|||||||
menu:
|
menu:
|
||||||
docs:
|
docs:
|
||||||
parent: quick-reference
|
parent: quick-reference
|
||||||
weight: 20
|
weight: 40
|
||||||
weight: 20
|
weight: 40
|
||||||
toc: true
|
toc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@ -6,8 +6,8 @@ keywords: []
|
|||||||
menu:
|
menu:
|
||||||
docs:
|
docs:
|
||||||
parent: quick-reference
|
parent: quick-reference
|
||||||
weight: 30
|
weight: 20
|
||||||
weight: 30
|
weight: 20
|
||||||
toc: true
|
toc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@ -6,8 +6,8 @@ keywords: []
|
|||||||
menu:
|
menu:
|
||||||
docs:
|
docs:
|
||||||
parent: quick-reference
|
parent: quick-reference
|
||||||
weight: 40
|
weight: 30
|
||||||
weight: 40
|
weight: 30
|
||||||
toc: true
|
toc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@ -33,7 +33,7 @@ The turning point was the introduction of a new key requirement---each document
|
|||||||
|
|
||||||
On top of that new development, we had to remember another one of our key requirements, namely, that mostly non-programmers were to be responsible for the service maintenance and content creation. Initially, we were leaning towards headless CMS-based solutions, but finally we made a bold move and decided to create a Git-managed Jamstack service and see what happens.
|
On top of that new development, we had to remember another one of our key requirements, namely, that mostly non-programmers were to be responsible for the service maintenance and content creation. Initially, we were leaning towards headless CMS-based solutions, but finally we made a bold move and decided to create a Git-managed Jamstack service and see what happens.
|
||||||
|
|
||||||
## Hugo to the rescue!
|
## Hugo to the rescue
|
||||||
|
|
||||||
Hugo was our first choice of SSG. The multilingualism support was the primary feature that convinced us. Later on, going through the documentation, we continued to discover new exciting features that we didn't even know we needed when we started.
|
Hugo was our first choice of SSG. The multilingualism support was the primary feature that convinced us. Later on, going through the documentation, we continued to discover new exciting features that we didn't even know we needed when we started.
|
||||||
|
|
||||||
|
|||||||
@ -62,7 +62,7 @@ The most encouraging result is how quick the site is around the world. Most Toma
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
This project was such a blast to develop, it’s a real pleasure to put new technologies to good use in production, and to see real performance and usability benefits from them. Even using classic web methods of serving folders with files is fun when you’ve been databasing for a while – there’s something really ‘pure’ about it.
|
This project was such a blast to develop, it’s a real pleasure to put new technologies to good use in production, and to see real performance and usability benefits from them. Even using classic web methods of serving folders with files is fun when you’ve been using dynamic systems for a while – there’s something really pure about it.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@ -22,7 +22,7 @@ We had two goals:
|
|||||||
|
|
||||||
**Make it fast**
|
**Make it fast**
|
||||||
|
|
||||||
We wanted to optimise the site as much as possible, so we opted for using Cloudinary, enabling us to take advantage of on-the-fly image manipulation, and thanks to the sheer speed of static sites, we achieved a perfect optimisation score with Google audits.
|
We wanted to optimize the site as much as possible, so we opted for using Cloudinary, enabling us to take advantage of on-the-fly image manipulation, and thanks to the sheer speed of static sites, we achieved a perfect optimization score with Google audits.
|
||||||
|
|
||||||
Because we're hosting the site through Netlify and our target audience is in America, we are taking advantage of Netlify edge (Their alternative to a CDN). We're talking blazing fast.
|
Because we're hosting the site through Netlify and our target audience is in America, we are taking advantage of Netlify edge (Their alternative to a CDN). We're talking blazing fast.
|
||||||
|
|
||||||
|
|||||||
@ -47,7 +47,7 @@ This template creates a robots.txt file with a `Disallow` directive for each pag
|
|||||||
{{% note %}}
|
{{% note %}}
|
||||||
To create a robots.txt file without using a template:
|
To create a robots.txt file without using a template:
|
||||||
|
|
||||||
1. Set `enableRobotsTXT` to `false` in the [site configuration].
|
1. Set `enableRobotsTXT` to `false` in the site configuration.
|
||||||
2. Create a robots.txt file in the `static` directory.
|
2. Create a robots.txt file in the `static` directory.
|
||||||
|
|
||||||
Remember that Hugo copies everything in the [static directory][static] to the root of `publishDir` (typically `public`) when you build your site.
|
Remember that Hugo copies everything in the [static directory][static] to the root of `publishDir` (typically `public`) when you build your site.
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
title: Frontend interfaces
|
title: Front-end interfaces
|
||||||
linkTitle: Frontends
|
linkTitle: Front-ends
|
||||||
description: Do you prefer a graphical user interface over a text editor? Give these frontends a try.
|
description: Do you prefer a graphical user interface over a text editor? Give these front-ends a try.
|
||||||
categories: [developer tools]
|
categories: [developer tools]
|
||||||
keywords: [frontend, gui]
|
keywords: [frontend, gui]
|
||||||
menu:
|
menu:
|
||||||
@ -10,6 +10,7 @@ menu:
|
|||||||
weight: 30
|
weight: 30
|
||||||
weight: 30
|
weight: 30
|
||||||
toc: true
|
toc: true
|
||||||
|
aliases: [/tools/frontends/]
|
||||||
---
|
---
|
||||||
|
|
||||||
## Commercial
|
## Commercial
|
||||||
@ -29,7 +29,7 @@ Use these methods to access content dates.
|
|||||||
|
|
||||||
Use these methods with your multilingual projects.
|
Use these methods with your multilingual projects.
|
||||||
|
|
||||||
{{< list-pages-in-section path=/methods/page filter=methods_page_multilinugual filterType=include titlePrefix=. omitElementIDs=true >}}
|
{{< list-pages-in-section path=/methods/page filter=methods_page_multilingual filterType=include titlePrefix=. omitElementIDs=true >}}
|
||||||
|
|
||||||
## Navigation
|
## Navigation
|
||||||
|
|
||||||
|
|||||||
@ -28,7 +28,7 @@ methods_page_dates:
|
|||||||
methods_page_menu:
|
methods_page_menu:
|
||||||
- /methods/page/hasmenucurrent
|
- /methods/page/hasmenucurrent
|
||||||
- /methods/page/ismenucurrent
|
- /methods/page/ismenucurrent
|
||||||
methods_page_multilinugual:
|
methods_page_multilingual:
|
||||||
- /methods/page/alltranslations
|
- /methods/page/alltranslations
|
||||||
- /methods/page/istranslated
|
- /methods/page/istranslated
|
||||||
- /methods/page/language
|
- /methods/page/language
|
||||||
|
|||||||
@ -39,7 +39,7 @@
|
|||||||
{{ end }}
|
{{ end }}
|
||||||
|
|
||||||
<div class="prose prose-{{ .Type }}" id="prose">
|
<div class="prose prose-{{ .Type }}" id="prose">
|
||||||
<div class="mb5">
|
<div class="mb4">
|
||||||
{{- partial "docs/functions-signatures.html" . -}}
|
{{- partial "docs/functions-signatures.html" . -}}
|
||||||
{{- partial "docs/functions-return-type.html" . -}}
|
{{- partial "docs/functions-return-type.html" . -}}
|
||||||
{{- partial "docs/functions-aliases.html" . -}}
|
{{- partial "docs/functions-aliases.html" . -}}
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user