From 98226fe61ea6c476fc00906599043ab1ca4ef462 Mon Sep 17 00:00:00 2001 From: Joe Mooring Date: Mon, 3 Apr 2023 16:29:03 -0700 Subject: [PATCH] Remove orphaned param fron admonition calls (#2042) --- content/en/content-management/front-matter.md | 2 +- content/en/content-management/shortcodes.md | 2 +- content/en/content-management/summaries.md | 2 +- content/en/content-management/taxonomies.md | 2 +- content/en/content-management/toc.md | 2 +- content/en/contribute/development.md | 2 +- content/en/functions/hugo.md | 2 +- content/en/functions/i18n.md | 2 +- content/en/functions/safeCSS.md | 2 +- content/en/getting-started/configuration.md | 2 +- content/en/templates/homepage.md | 2 +- content/en/templates/introduction.md | 2 +- content/en/templates/pagination.md | 2 +- content/en/templates/rss.md | 2 +- content/en/tools/starter-kits.md | 2 +- content/en/variables/git.md | 2 +- 16 files changed, 16 insertions(+), 16 deletions(-) diff --git a/content/en/content-management/front-matter.md b/content/en/content-management/front-matter.md index a7e74feb4..78d3323dd 100644 --- a/content/en/content-management/front-matter.md +++ b/content/en/content-management/front-matter.md @@ -134,7 +134,7 @@ weight \ : Field name of the *plural* form of the index. See `tags` and `categories` in the above front matter examples. *Note that the plural form of user-defined taxonomies cannot be the same as any of the predefined front matter variables.* -{{% note "Hugo's Default URL Destinations" %}} +{{% note %}} If neither `slug` nor `url` is present and [permalinks are not configured otherwise in your site `config` file](/content-management/urls/#permalinks), Hugo will use the filename of your content to create the output URL. See [Content Organization](/content-management/organization) for an explanation of paths in Hugo and [URL Management](/content-management/urls/) for ways to customize Hugo's default behaviors. {{% /note %}} diff --git a/content/en/content-management/shortcodes.md b/content/en/content-management/shortcodes.md index 000e1e302..f91adc227 100644 --- a/content/en/content-management/shortcodes.md +++ b/content/en/content-management/shortcodes.md @@ -273,7 +273,7 @@ These shortcodes will look up the pages by their relative path (e.g., `blog/post `ref` and `relref` also make it possible to make fragmentary links that work for the header links generated by Hugo. -{{% note "More on Cross References" %}} +{{% note %}} Read a more extensive description of `ref` and `relref` in the [cross references](/content-management/cross-references/) documentation. {{% /note %}} diff --git a/content/en/content-management/summaries.md b/content/en/content-management/summaries.md index 76636fad3..3156afa20 100644 --- a/content/en/content-management/summaries.md +++ b/content/en/content-management/summaries.md @@ -43,7 +43,7 @@ For [Org mode content][org], use `# more` where you want to split the article. Content that comes before the summary divider will be used as that content's summary and stored in the `.Summary` page variable with all HTML formatting intact. -{{% note "Summary Divider"%}} +{{% note %}} The concept of a *summary divider* is not unique to Hugo. It is also called the "more tag" or "excerpt separator" in other literature. {{% /note %}} diff --git a/content/en/content-management/taxonomies.md b/content/en/content-management/taxonomies.md index 0aef87395..fe42a0667 100644 --- a/content/en/content-management/taxonomies.md +++ b/content/en/content-management/taxonomies.md @@ -182,7 +182,7 @@ categories_weight = 44 By using taxonomic weight, the same piece of content can appear in different positions in different taxonomies. -{{% note "Limits to Ordering Taxonomies" %}} +{{% note %}} Currently taxonomies only support the [default `weight => date` ordering of list content](/templates/lists/#default-weight--date--linktitle--filepath). For more information, see the documentation on [taxonomy templates](/templates/taxonomy-templates/). {{% /note %}} diff --git a/content/en/content-management/toc.md b/content/en/content-management/toc.md index 499a31511..4215107fb 100644 --- a/content/en/content-management/toc.md +++ b/content/en/content-management/toc.md @@ -12,7 +12,7 @@ weight: 210 aliases: [/extras/toc/] --- -{{% note "TOC Heading Levels are Fixed" %}} +{{% note %}} Previously, there was no out-of-the-box way to specify which heading levels you want the TOC to render. [See the related GitHub discussion (#1778)](https://github.com/gohugoio/hugo/issues/1778). As such, the resulting `` was going to start at `

` when pulling from `{{ .Content }}`. diff --git a/content/en/contribute/development.md b/content/en/contribute/development.md index b3acbdedf..cb56783e9 100644 --- a/content/en/contribute/development.md +++ b/content/en/contribute/development.md @@ -23,7 +23,7 @@ This contribution guide takes a step-by-step approach in hopes of helping newcom * You are new to Git or open-source projects in general * You are a fan of Hugo and enthusiastic about contributing to the project -{{% note "Additional Questions?" %}} +{{% note %}} If you're struggling at any point in this contribution guide, reach out to the Hugo community in [Hugo's Discussion forum](https://discourse.gohugo.io). {{% /note %}} diff --git a/content/en/functions/hugo.md b/content/en/functions/hugo.md index 9da434653..0e31ec5c4 100644 --- a/content/en/functions/hugo.md +++ b/content/en/functions/hugo.md @@ -37,7 +37,7 @@ hugo.IsExtended hugo.IsProduction : returns true if `hugo.Environment` is set to the production environment -{{% note "Use the Hugo Generator Tag" %}} +{{% note %}} We highly recommend using `hugo.Generator` in your website's ``. `hugo.Generator` is included by default in all themes hosted on [themes.gohugo.io](https://themes.gohugo.io). The generator tag allows the Hugo team to track the usage and popularity of Hugo. {{% /note %}} diff --git a/content/en/functions/i18n.md b/content/en/functions/i18n.md index d342339c3..13f3a6f8f 100644 --- a/content/en/functions/i18n.md +++ b/content/en/functions/i18n.md @@ -19,7 +19,7 @@ This translates a piece of content based on your `i18n/en-US.toml` files. You ca {{ i18n "translation_id" }} ``` -{{% note "Alias `T`" %}} +{{% note %}} `T` is an alias to `i18n`. E.g. `{{ T "translation_id" }}`. {{% /note %}} diff --git a/content/en/functions/safeCSS.md b/content/en/functions/safeCSS.md index 1d3708be3..93595286c 100644 --- a/content/en/functions/safeCSS.md +++ b/content/en/functions/safeCSS.md @@ -22,6 +22,6 @@ Example: Given `style = "color: red;"` defined in the front matter of your `.md` * `

…

` → `

…

` * `

…

` → `

…

` -{{% note "ZgotmplZ" %}} +{{% note %}} "ZgotmplZ" is a special value that indicates that unsafe content reached a CSS or URL context. {{% /note %}} diff --git a/content/en/getting-started/configuration.md b/content/en/getting-started/configuration.md index 4a946e308..f8f4bbf43 100644 --- a/content/en/getting-started/configuration.md +++ b/content/en/getting-started/configuration.md @@ -630,7 +630,7 @@ $ env HUGO_TITLE="Some Title" hugo This is really useful if you use a service such as Netlify to deploy your site. Look at the Hugo docs [Netlify configuration file](https://github.com/gohugoio/hugoDocs/blob/master/netlify.toml) for an example. -{{% note "Setting Environment Variables" %}} +{{% note %}} Names must be prefixed with `HUGO_` and the configuration key must be set in uppercase when setting operating system environment variables. To set config params, prefix the name with `HUGO_PARAMS_` diff --git a/content/en/templates/homepage.md b/content/en/templates/homepage.md index f94aa606b..0bab21ed5 100644 --- a/content/en/templates/homepage.md +++ b/content/en/templates/homepage.md @@ -15,7 +15,7 @@ toc: true Homepage is a `Page` and therefore has all the [page variables][pagevars] and [site variables][sitevars] available for use. -{{% note "The Only Required Template" %}} +{{% note %}} The homepage template is the *only* required template for building a site and therefore useful when bootstrapping a new site and template. It is also the only required template if you are developing a single-page website. {{% /note %}} diff --git a/content/en/templates/introduction.md b/content/en/templates/introduction.md index 28411ea0c..f02f1dfce 100644 --- a/content/en/templates/introduction.md +++ b/content/en/templates/introduction.md @@ -136,7 +136,7 @@ Go Templates only ship with a few basic functions but also provide a mechanism f Note that both examples make use of Go Template's [math][math] functions. -{{% note "Additional Boolean Operators" %}} +{{% note %}} There are more boolean operators than those listed in the Hugo docs in the [Go Template documentation](https://golang.org/pkg/text/template/#hdr-Functions). {{% /note %}} diff --git a/content/en/templates/pagination.md b/content/en/templates/pagination.md index 507afcc9d..5de1f661d 100644 --- a/content/en/templates/pagination.md +++ b/content/en/templates/pagination.md @@ -69,7 +69,7 @@ The easiest way to add this to your pages is to include the built-in template (w {{ template "_internal/pagination.html" . }} ``` -{{% note "When to Create `.Paginator`" %}} +{{% note %}} If you use any filters or ordering functions to create your `.Paginator` *and* you want the navigation buttons to be shown before the page listing, you must create the `.Paginator` before it's used. {{% /note %}} diff --git a/content/en/templates/rss.md b/content/en/templates/rss.md index e1bd19e54..af2ee2c12 100644 --- a/content/en/templates/rss.md +++ b/content/en/templates/rss.md @@ -15,7 +15,7 @@ toc: true See [Template Lookup Order](/templates/lookup-order/) for the complete reference. -{{% note "Hugo Ships with an RSS Template" %}} +{{% note %}} Hugo ships with its own [RSS 2.0 template](#the-embedded-rssxml). The embedded template will be sufficient for most use cases. {{% /note %}} diff --git a/content/en/tools/starter-kits.md b/content/en/tools/starter-kits.md index deaa3411c..fa2dde48e 100644 --- a/content/en/tools/starter-kits.md +++ b/content/en/tools/starter-kits.md @@ -12,7 +12,7 @@ aliases: [/developer-tools/migrations/,/developer-tools/migrated/] Know of a Hugo-related starter kit that isn't mentioned here? [Please add it to the list.][addkit] -{{% note "Starter Kits are Not Maintained by the Hugo Team"%}} +{{% note %}} The following starter kits are developed by active members of the Hugo community. If you find yourself having issues with any of the projects, it's best to file an issue directly with the project's maintainer(s). {{% /note %}} diff --git a/content/en/variables/git.md b/content/en/variables/git.md index 293acf72c..dfd6e5407 100644 --- a/content/en/variables/git.md +++ b/content/en/variables/git.md @@ -12,7 +12,7 @@ weight: 70 aliases: [/extras/gitinfo/] --- -{{% note "`.GitInfo` Performance Considerations" %}} +{{% note %}} Hugo's Git integrations should be fairly performant but *can* increase your build time. This will depend on the size of your Git history. {{% /note %}}