diff options
author | Christian Oliff <1212885+coliff@users.noreply.github.com> | 2022-03-27 07:09:06 +0300 |
---|---|---|
committer | Christian Oliff <1212885+coliff@users.noreply.github.com> | 2022-03-27 07:09:06 +0300 |
commit | 4d104c31b2780a5bbae93d0b284d275b02c9fa77 (patch) | |
tree | 6e8d1537038fdf19ac8361e91b122f19d4bf81eb | |
parent | 60653c17da508e53331b1e79a238f3618c186f40 (diff) |
cSpell config update
I added some useful ignore regexs and added the: "allowCompoundWords": true, rule, added remaining words to allowlist and ignored the news and showcase folders. There are now no reported errors!
-rw-r--r-- | .cspell.json | 64 | ||||
-rw-r--r-- | content/en/functions/cond.md | 1 | ||||
-rw-r--r-- | content/en/functions/default.md | 1 | ||||
-rw-r--r-- | content/en/functions/uniq.md | 1 | ||||
-rw-r--r-- | content/en/getting-started/configuration.md | 8 | ||||
-rw-r--r-- | content/en/hosting-and-deployment/hosting-on-keycdn.md | 4 | ||||
-rw-r--r-- | content/en/hosting-and-deployment/hosting-on-render.md | 2 | ||||
-rw-r--r-- | content/en/hugo-modules/configuration.md | 2 | ||||
-rw-r--r-- | content/en/showcase/hapticmedia/index.md | 3 | ||||
-rw-r--r-- | content/en/templates/ordering-and-grouping.md | 4 | ||||
-rw-r--r-- | layouts/maintenance/list.html | 2 |
11 files changed, 73 insertions, 19 deletions
diff --git a/.cspell.json b/.cspell.json index 2cac73c02..5eee5bc8a 100644 --- a/.cspell.json +++ b/.cspell.json @@ -6,6 +6,8 @@ "aabba", "aabbaa", "aabbaabb", + "aabbaabbab", + "abbaa", "abourget", "absurl", "adoc", @@ -18,7 +20,11 @@ "attrlink", "azblob", "baseof", + "bbaa", + "bcde", + "bcdef", "beevelop", + "Bergevin", "bibtex", "Bjørn", "blackfriday", @@ -31,6 +37,7 @@ "canonify", "Catmull", "Catwoman", + "changefreq", "Cheatsheet", "choco", "chromastyles", @@ -42,12 +49,15 @@ "Coen", "Commento", "Cond", + "contentdir", "Contentful", + "Copr", "copyrighthtml", "corejs", "countrunes", "countwords", "crossreferences", + "daftaupe", "datatable", "DATOCMS", "debugconfig", @@ -60,6 +70,8 @@ "dokuwiki", "dpkg", "DRING", + "Eiqc", + "Eliott", "Emojify", "Enwrite", "eopkg", @@ -68,6 +80,7 @@ "erroridf", "Evernote", "exitwp", + "expirydate", "Feminella", "firstpost", "Formspree", @@ -95,7 +108,9 @@ "Grayscale", "Gruber", "gtag", + "gvfs", "hidecaption", + "hmac", "Hokus", "hola", "hügó", @@ -121,6 +136,7 @@ "Isset", "Isso", "Jaco", + "JIRN", "johnpatitucci", "Joomla", "JRBR", @@ -142,10 +158,13 @@ "mathjax", "mdhender", "mdshortcode", + "MENUENTRY", "mercredi", + "Milli", "Mittwoch", "mkdir", "mmark", + "modh", "monokai", "Morling", "mspowerpoint", @@ -155,17 +174,20 @@ "mydeployment", "myindex", "mylayout", + "mylogin", "mypage", "mypartials", "mypost", "mysite", "myspa", "mystyle", + "mytextpartial", "mytheme", "NDJSON", "needsexample", "Netravali", "newparam", + "Nichlas", "Nikhil", "Njjy", "nlist", @@ -176,6 +198,7 @@ "NOSQL", "notoc", "novembre", + "numfmt", "NUMWORKERMULTIPLIER", "Obhu", "octohug", @@ -191,18 +214,25 @@ "PCRE", "peaceiris", "Pedersen", + "Pekka", "permalinkable", "plainify", "POSIX", "postprocess", + "Poupin", + "prerender", "println", "publishdate", "Pygments", + "qref", "querify", "QVOMC", + "Racic", + "Rclone", "rdwatters", "readfile", "rebinded", + "recommendedby", "REDIR", "reftext", "relatedfuncs", @@ -210,16 +240,21 @@ "relurl", "remarkjs", "rgba", + "Riku", "rlimit", "roboto", "rssxml", "rwxrwxrwx", + "RYUGV", "safehtml", "safejs", "Samsa", + "schemaorg", "Shekhar", "Shortcode", "Shortcodes", + "signup", + "Silvola", "Sindre", "sitemapindex", "sitemapxml", @@ -231,24 +266,31 @@ "struct", "structs", "subdir", + "svgs", + "symdiff", "Talkyard", "taxo", + "taxonomyname", "tbody", "tdewolff", "testshortcodes", "thead", "Thinkful", + "Tknx", "TLDR", "TMPDIR", + "TOCSS", "tojson", + "Tomango", + "topologix", "Torikian", "totoml", "toyaml", "twitteruser", "Unmarshal", - "Unmarshal", "urlize", "urlset", + "utimestamp", "vimrc", "wanghc", "Wappalyzer", @@ -258,19 +300,35 @@ "wibble", "wordcount", "workson", + "wpxr", + "Xbaabbab", "xvzf", "yoyoyo", "Zgotmpl", - "zzbbaabb" + "zzbbaabb", + "مدونتي" ], "language": "en,en-GB,en-US,de,fr", + "allowCompoundWords": true, "files": [ "**/*.md" ], + "ignoreRegExpList": [ + "<!-- prettier-ignore -->\\n(`{3,})\\w*\\n[\\s\\S]+?\\1", + "\\[(\\*{2})?@\\w+?\\1\\]", + "\\[`\\w+`\\]", + "ve{2,}r{2,}y", + "ve+r+y+long\\w*", + "\\/.*?\\/", + "\\_\\w+", + "\\#\\w+" + ], "ignorePaths": [ ".cspell.json", "**/node_modules/**", - "*.min.*" + "*.min.*", + "**/news/*", + "**/showcase/*" ], "useGitignore": true } diff --git a/content/en/functions/cond.md b/content/en/functions/cond.md index a5e534426..30b853251 100644 --- a/content/en/functions/cond.md +++ b/content/en/functions/cond.md @@ -11,7 +11,6 @@ hugoversion: 0.27 relatedfuncs: [default] toc: false draft: false -needsexamples: false --- `cond` returns *VAR1* if *CONTROL* is true, or *VAR2* if it is not. diff --git a/content/en/functions/default.md b/content/en/functions/default.md index eee00b200..c4cc166a7 100644 --- a/content/en/functions/default.md +++ b/content/en/functions/default.md @@ -18,7 +18,6 @@ relatedfuncs: [] deprecated: false draft: false aliases: [] -needsexamples: false --- `default` checks whether a given value is set and returns a default value if it is not. *Set* in this context means different things depending on the data type: diff --git a/content/en/functions/uniq.md b/content/en/functions/uniq.md index 0a720f88f..eec55e5c3 100644 --- a/content/en/functions/uniq.md +++ b/content/en/functions/uniq.md @@ -16,7 +16,6 @@ hugoversion: relatedfuncs: [] deprecated: false aliases: [] -needsexamples: false --- ``` diff --git a/content/en/getting-started/configuration.md b/content/en/getting-started/configuration.md index aed0ea100..6bb8b62f5 100644 --- a/content/en/getting-started/configuration.md +++ b/content/en/getting-started/configuration.md @@ -46,7 +46,7 @@ In addition to using a single site config file, one can use the `configDir` dire - Each file represents a configuration root object, such as `params.toml` for `[Params]`, `menu(s).toml` for `[Menu]`, `languages.toml` for `[Languages]` etc... - Each file's content must be top-level, for example: - + {{< code-toggle file="config" >}} [Params] foo = "bar" @@ -220,7 +220,7 @@ Disable automatic live reloading of browser window. : Do not convert the url/path to lowercase. -### enableEmoji +### enableEmoji **Default value:** false @@ -279,6 +279,7 @@ Google Analytics tracking ID. If true, auto-detect Chinese/Japanese/Korean Languages in the content. This will make `.Summary` and `.WordCount` behave correctly for CJK languages. ### imaging + See [Image Processing Config](/content-management/image-processing/#image-processing-config). ### languageCode @@ -288,6 +289,7 @@ See [Image Processing Config](/content-management/image-processing/#image-proces A language tag as defined by [RFC 5646](https://datatracker.ietf.org/doc/html/rfc5646). The internal [RSS template](https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/_default/rss.xml) populates its `<language>` element with this value. The value is not used elsewhere. ### languages + See [Configure Languages](/content-management/multilingual/#configure-languages). ### disableLanguages @@ -330,7 +332,7 @@ Don't sync modification time of files. ### outputFormats See [Configure Output Formats](#configure-additional-output-formats). -### paginate +### paginate **Default value:** 10 diff --git a/content/en/hosting-and-deployment/hosting-on-keycdn.md b/content/en/hosting-and-deployment/hosting-on-keycdn.md index 8d9cb0e63..bec8b36e4 100644 --- a/content/en/hosting-and-deployment/hosting-on-keycdn.md +++ b/content/en/hosting-and-deployment/hosting-on-keycdn.md @@ -83,11 +83,11 @@ The Zone ID and API key are used to purge your zone – it’s not strictly need Now it’s time to push the newly created repository to GitLab: ``` -git remote add origin git@gitlab.com:youruser/ciexample.git +git remote add origin git@gitlab.com:youruser/ci-example.git git push -u origin master ``` -You can watch the progress and CI job output in your Gitlab project under “Pipelines”. +You can watch the progress and CI job output in your Gitlab project under “Pipelines”. After verifying your CI job ran without issues, first check that your GitLab page shows up under `https://youruser.gitlab.io/reponame/` (it might look broken depending on your browser settings as all links point to your KeyCDN zone – don’t worry about that) and then by heading to whatever Zone alias / Zone URL you defined. diff --git a/content/en/hosting-and-deployment/hosting-on-render.md b/content/en/hosting-and-deployment/hosting-on-render.md index 7a77742e2..73b20bcb2 100644 --- a/content/en/hosting-and-deployment/hosting-on-render.md +++ b/content/en/hosting-and-deployment/hosting-on-render.md @@ -4,7 +4,6 @@ linktitle: Host on Render description: Host your Hugo site for free with Render's global CDN, fully-managed SSL and auto deploys from GitHub. date: 2019-06-06 publishdate: 2019-06-06 -lastmod: 2020-01-01 categories: [hosting and deployment] keywords: [hosting,deployment] authors: [Anurag Goel] @@ -88,5 +87,4 @@ Render automatically downloads all Git submodules defined in your Git repo on ev Chat with Render developers at https://render.com/chat or email `support@render.com` if you need help. - [Quick Start]: /getting-started/quick-start/ diff --git a/content/en/hugo-modules/configuration.md b/content/en/hugo-modules/configuration.md index c66d93a6d..0c1c367d1 100644 --- a/content/en/hugo-modules/configuration.md +++ b/content/en/hugo-modules/configuration.md @@ -46,7 +46,7 @@ workspace {{< new-in "0.83.0" >}} The workspace file to use. This enables Go workspace mode. Note that this can also be set via OS env, e.g. `export HUGO_MODULE_WORKSPACE=/my/hugo.work` This only works with Go 1.18+. replacements {{< new-in "0.77.0" >}} -: A comma separated (or a slice) list of module path to directory replacement mapping, e.g. `github.com/bep/myprettytheme -> ../..,github.com/bep/shortcodes -> /some/path`. This is mostly useful for temporary locally development of a module, and then it makes sense to set it as an OS environment variable, e.g: `env HUGO_MODULE_REPLACEMENTS="github.com/bep/myprettytheme -> ../.."`. Any relative path is relate to [themesDir](https://gohugo.io/getting-started/configuration/#all-configuration-settings), and absolute paths are allowed. +: A comma separated (or a slice) list of module path to directory replacement mapping, e.g. `github.com/bep/my-theme -> ../..,github.com/bep/shortcodes -> /some/path`. This is mostly useful for temporary locally development of a module, and then it makes sense to set it as an OS environment variable, e.g: `env HUGO_MODULE_REPLACEMENTS="github.com/bep/my-theme -> ../.."`. Any relative path is relate to [themesDir](https://gohugo.io/getting-started/configuration/#all-configuration-settings), and absolute paths are allowed. Note that the above terms maps directly to their counterparts in Go Modules. Some of these setting may be natural to set as OS environment variables. To set the proxy server to use, as an example: diff --git a/content/en/showcase/hapticmedia/index.md b/content/en/showcase/hapticmedia/index.md index b32879b69..85ec17a8b 100644 --- a/content/en/showcase/hapticmedia/index.md +++ b/content/en/showcase/hapticmedia/index.md @@ -18,7 +18,7 @@ Hugo addresses all these needs, coupled with [Forestry.io](https://forestry.io/) - The **multilingual** content support, especially simple to setup. - The **multiple environments** support (develop, staging, test, production, ...). - Although a hard start with the Go language, the power of the **Hugo's templating**. -- The **partial layouts**, including the `internals` (e.g. social metas). +- The **partial layouts**, including the `internals` (e.g. social meta tags). - The **build time**, unbeatable ⚡️⚡️⚡️. @@ -30,4 +30,3 @@ Hugo addresses all these needs, coupled with [Forestry.io](https://forestry.io/) - **[Forestry.io](https://forestry.io)** for the content management. **All of these tools allow our editor to manage the blog's content without having to worry about its technical aspect, which is managed by the developers.** - diff --git a/content/en/templates/ordering-and-grouping.md b/content/en/templates/ordering-and-grouping.md index a4f238fdf..f1634c7d8 100644 --- a/content/en/templates/ordering-and-grouping.md +++ b/content/en/templates/ordering-and-grouping.md @@ -1,5 +1,5 @@ --- -title: Ordere and Grouping Hugo Lists +title: Ordering and Grouping Hugo Lists linktitle: List Ordering and Grouping description: You can group or order your content in both your templating and content front matter. date: 2017-02-01 @@ -19,7 +19,7 @@ toc: true notes: This was originally going to be a separate page on the new docs site but it now makes more sense to keep everything within the templates/lists page. - rdwatters, 2017-03-12. --- -In Hugo, A list template is any template that will be used to render multiple pieces of content in a single HTML page. +In Hugo, a list template is any template that will be used to render multiple pieces of content in a single HTML page. ## Example List Templates diff --git a/layouts/maintenance/list.html b/layouts/maintenance/list.html index 299602318..2035c058b 100644 --- a/layouts/maintenance/list.html +++ b/layouts/maintenance/list.html @@ -15,7 +15,7 @@ <div class="w-100"> {{ $byLastMod := .Site.RegularPages.ByLastmod }} {{ $recent := ($byLastMod | last 30).Reverse }} - {{ $leastRecent := $byLastMod | first 10 }} + {{ $leastRecent := $byLastMod | first 10 }} <h2 id="last-updated">Last Updated</h2> {{ partial "maintenance-pages-table.html" $recent }} <h2 id="least-recently-updated">Least Recently Updated</h2> |