From ce207e1416e16aadf7965f642479281ce5868690 Mon Sep 17 00:00:00 2001 From: Joe Mooring Date: Sun, 18 Dec 2022 16:54:18 -0800 Subject: [PATCH] Remove redundant markdown and fix a few typos (#1936) --- content/en/about/benefits.md | 8 ++-- content/en/about/features.md | 46 +++++++++---------- content/en/about/what-is-hugo.md | 4 +- content/en/content-management/archetypes.md | 2 +- content/en/content-management/comments.md | 2 +- content/en/content-management/front-matter.md | 6 +-- .../content-management/organization/index.md | 4 +- content/en/content-management/sections.md | 4 +- content/en/content-management/shortcodes.md | 10 ++-- content/en/content-management/static-files.md | 4 +- content/en/content-management/summaries.md | 2 +- content/en/content-management/taxonomies.md | 14 +++--- content/en/content-management/toc.md | 4 +- content/en/content-management/urls.md | 4 +- content/en/contribute/development.md | 2 +- content/en/contribute/documentation.md | 4 +- content/en/functions/GetPage.md | 2 +- content/en/functions/after.md | 2 +- content/en/functions/apply.md | 6 +-- content/en/functions/format.md | 2 +- content/en/functions/len.md | 8 ++-- content/en/functions/markdownify.md | 2 +- content/en/functions/param.md | 4 +- content/en/functions/render.md | 2 +- content/en/functions/safeURL.md | 2 +- content/en/functions/seq.md | 2 +- content/en/functions/slice.md | 2 +- content/en/functions/time.md | 2 +- content/en/getting-started/_index.md | 2 +- content/en/getting-started/configuration.md | 6 +-- .../en/getting-started/directory-structure.md | 22 ++++----- .../hosting-on-aws-amplify.md | 2 +- .../hosting-on-azure.md | 2 +- .../hosting-on-firebase.md | 8 ++-- .../hosting-on-github.md | 4 +- .../hosting-on-netlify.md | 10 ++-- .../hosting-on-render.md | 2 +- .../en/hosting-and-deployment/hugo-deploy.md | 3 +- content/en/readfiles/dateformatting.md | 2 +- content/en/templates/data-templates.md | 4 +- content/en/templates/homepage.md | 2 +- content/en/templates/internal.md | 2 +- content/en/templates/introduction.md | 6 +-- content/en/templates/lists.md | 4 +- content/en/templates/output-formats.md | 4 +- content/en/templates/pagination.md | 2 +- content/en/templates/partials.md | 2 +- content/en/templates/shortcode-templates.md | 8 ++-- content/en/templates/single-page-templates.md | 4 +- content/en/templates/taxonomy-templates.md | 2 +- content/en/templates/template-debugging.md | 2 +- content/en/tools/starter-kits.md | 6 +-- content/en/variables/page.md | 2 +- content/zh/templates/base.md | 2 +- 54 files changed, 135 insertions(+), 136 deletions(-) diff --git a/content/en/about/benefits.md b/content/en/about/benefits.md index e4fec5bb2..925da1732 100644 --- a/content/en/about/benefits.md +++ b/content/en/about/benefits.md @@ -27,11 +27,11 @@ This has many benefits. The most noticeable is performance. HTTP servers are *ve ## More on Static Site Generators -* ["An Introduction to Static Site Generators", David Walsh][] +* ["An Introduction to Static Site Generators", David Walsh] * ["Hugo vs. WordPress page load speed comparison: Hugo leaves WordPress in its dust", GettingThingsTech][hugovwordpress] -* ["Static Site Generators", O'Reilly][] -* [StaticGen: Top Open-Source Static Site Generators (GitHub Stars)][] -* ["Top 10 Static Website Generators", Netlify blog][] +* ["Static Site Generators", O'Reilly] +* [StaticGen: Top Open-Source Static Site Generators (GitHub Stars)] +* ["Top 10 Static Website Generators", Netlify blog] * ["The Resurgence of Static", dotCMS][dotcms] ["An Introduction to Static Site Generators", David Walsh]: https://davidwalsh.name/introduction-static-site-generators diff --git a/content/en/about/features.md b/content/en/about/features.md index 5e94de38c..fc3d5a030 100644 --- a/content/en/about/features.md +++ b/content/en/about/features.md @@ -17,42 +17,42 @@ toc: true ## General -* [Extremely fast][] build times (< 1 ms per page) +* [Extremely fast] build times (< 1 ms per page) * Completely cross platform, with [easy installation][install] on macOS, Linux, Windows, and more -* Renders changes on the fly with [LiveReload][] as you develop -* [Powerful theming][] +* Renders changes on the fly with [LiveReload] as you develop +* [Powerful theming] * [Host your site anywhere][hostanywhere] ## Organization -* Straightforward [organization for your projects][], including website sections -* Customizable [URLs][] -* Support for configurable [taxonomies][], including categories and tags -* [Sort content][] as you desire through powerful template [functions][] -* Automatic [table of contents][] generation -* [Dynamic menu][] creation -* [Pretty URLs][] support -* [Permalink][] pattern support -* Redirects via [aliases][] +* Straightforward [organization for your projects], including website sections +* Customizable [URLs] +* Support for configurable [taxonomies], including categories and tags +* [Sort content] as you desire through powerful template [functions] +* Automatic [table of contents] generation +* [Dynamic menu] creation +* [Pretty URLs] support +* [Permalink] pattern support +* Redirects via [aliases] ## Content -* Native Markdown and Emacs Org-Mode support, as well as other languages via *external helpers* (see [supported formats][]) -* TOML, YAML, and JSON metadata support in [front matter][] -* Customizable [homepage][] -* Multiple [content types][] -* Automatic and user defined [content summaries][] -* [Shortcodes][] to enable rich content inside of Markdown +* Native Markdown and Emacs Org-Mode support, as well as other languages via *external helpers* (see [supported formats]) +* TOML, YAML, and JSON metadata support in [front matter] +* Customizable [homepage] +* Multiple [content types] +* Automatic and user defined [content summaries] +* [Shortcodes] to enable rich content inside of Markdown * ["Minutes to Read"][pagevars] functionality * ["WordCount"][pagevars] functionality ## Additional Features -* Integrated [Disqus][] comment support -* Integrated [Google Analytics][] support -* Automatic [RSS][] creation -* Support for [Go][] HTML templates -* [Syntax highlighting][] powered by [Chroma][] +* Integrated [Disqus] comment support +* Integrated [Google Analytics] support +* Automatic [RSS] creation +* Support for [Go] HTML templates +* [Syntax highlighting] powered by [Chroma] [aliases]: /content-management/urls/#aliases [Chroma]: https://github.com/alecthomas/chroma diff --git a/content/en/about/what-is-hugo.md b/content/en/about/what-is-hugo.md index 01fac90c8..d61f821cd 100644 --- a/content/en/about/what-is-hugo.md +++ b/content/en/about/what-is-hugo.md @@ -17,9 +17,9 @@ aliases: [/overview/introduction/,/about/why-i-built-hugo/] toc: true --- -Hugo is a general-purpose website framework. Technically speaking, Hugo is a [static site generator][]. Unlike systems that dynamically build a page with each visitor request, Hugo builds pages when you create or update your content. Since websites are viewed far more often than they are edited, Hugo is designed to provide an optimal viewing experience for your website's end users and an ideal writing experience for website authors. +Hugo is a general-purpose website framework. Technically speaking, Hugo is a [static site generator]. Unlike systems that dynamically build a page with each visitor request, Hugo builds pages when you create or update your content. Since websites are viewed far more often than they are edited, Hugo is designed to provide an optimal viewing experience for your website's end users and an ideal writing experience for website authors. -Websites built with Hugo are extremely fast and secure. Hugo sites can be hosted anywhere, including [Netlify][], [Heroku][], [GoDaddy][], [DreamHost][], [GitHub Pages][], [GitLab Pages][], [Surge][], [Firebase][], [Google Cloud Storage][], [Amazon S3][], [Rackspace][], [Azure][], and [CloudFront][] and work well with CDNs. Hugo sites run without the need for a database or dependencies on expensive runtimes like Ruby, Python, or PHP. +Websites built with Hugo are extremely fast and secure. Hugo sites can be hosted anywhere, including [Netlify], [Heroku], [GoDaddy], [DreamHost], [GitHub Pages], [GitLab Pages], [Surge], [Firebase], [Google Cloud Storage], [Amazon S3], [Rackspace], [Azure], and [CloudFront] and work well with CDNs. Hugo sites run without the need for a database or dependencies on expensive runtimes like Ruby, Python, or PHP. We think of Hugo as the ideal website creation tool with nearly instant build times, able to rebuild whenever a change is made. diff --git a/content/en/content-management/archetypes.md b/content/en/content-management/archetypes.md index 31e229838..1d2ba3179 100644 --- a/content/en/content-management/archetypes.md +++ b/content/en/content-management/archetypes.md @@ -16,7 +16,7 @@ aliases: [/content/archetypes/] ## What are Archetypes? -**Archetypes** are content template files in the [archetypes directory][] of your project that contain preconfigured [front matter][] and possibly also a content disposition for your website's [content types][]. These will be used when you run `hugo new`. +**Archetypes** are content template files in the [archetypes directory] of your project that contain preconfigured [front matter] and possibly also a content disposition for your website's [content types]. These will be used when you run `hugo new`. The `hugo new` uses the `content-section` to find the most suitable archetype template in your project. If your project does not contain any archetype files, it will also look in the theme. diff --git a/content/en/content-management/comments.md b/content/en/content-management/comments.md index bb6a8d6ce..e49711e7c 100644 --- a/content/en/content-management/comments.md +++ b/content/en/content-management/comments.md @@ -29,7 +29,7 @@ Disqus comments require you set a single value in your [site's configuration fil disqusShortname = "yourDisqusShortname" {{}} -For many websites, this is enough configuration. However, you also have the option to set the following in the [front matter][] of a single content file: +For many websites, this is enough configuration. However, you also have the option to set the following in the [front matter] of a single content file: * `disqus_identifier` * `disqus_title` diff --git a/content/en/content-management/front-matter.md b/content/en/content-management/front-matter.md index 71e6e36ea..bf530518f 100644 --- a/content/en/content-management/front-matter.md +++ b/content/en/content-management/front-matter.md @@ -14,7 +14,7 @@ weight: 60 aliases: [/content/front-matter/] --- -**Front matter** allows you to keep metadata attached to an instance of a [content type][]---i.e., embedded inside a content file---and is one of the many features that gives Hugo its strength. +**Front matter** allows you to keep metadata attached to an instance of a [content type]---i.e., embedded inside a content file---and is one of the many features that gives Hugo its strength. {{< youtube Yh2xKRJGff4 >}} @@ -122,7 +122,7 @@ title : the title for the content. type -: the type of the content; this value will be automatically derived from the directory (i.e., the [section][]) if not specified in front matter. +: the type of the content; this value will be automatically derived from the directory (i.e., the [section]) if not specified in front matter. url : the full path to the content from the web root. It makes no assumptions about the path of the content file. See [URL Management](/content-management/urls/#set-url-in-front-matter). @@ -144,7 +144,7 @@ If neither `slug` nor `url` is present and [permalinks are not configured otherw You can add fields to your front matter arbitrarily to meet your needs. These user-defined key-values are placed into a single `.Params` variable for use in your templates. -The following fields can be accessed via `.Params.include_toc` and `.Params.show_comments`, respectively. The [Variables][] section provides more information on using Hugo's page- and site-level variables in your templates. +The following fields can be accessed via `.Params.include_toc` and `.Params.show_comments`, respectively. The [Variables] section provides more information on using Hugo's page- and site-level variables in your templates. {{< code-toggle copy="false" >}} include_toc: true diff --git a/content/en/content-management/organization/index.md b/content/en/content-management/organization/index.md index b677d8c18..94c0cfd5a 100644 --- a/content/en/content-management/organization/index.md +++ b/content/en/content-management/organization/index.md @@ -33,7 +33,7 @@ The bundle documentation is a **work in progress**. We will publish more compreh In Hugo, your content should be organized in a manner that reflects the rendered website. -While Hugo supports content nested at any level, the top levels (i.e. `content/`) are special in Hugo and are considered the content type used to determine layouts etc. To read more about sections, including how to nest them, see [sections][]. +While Hugo supports content nested at any level, the top levels (i.e. `content/`) are special in Hugo and are considered the content type used to determine layouts etc. To read more about sections, including how to nest them, see [sections]. Without any additional configuration, the following will automatically work: @@ -59,7 +59,7 @@ The following demonstrates the relationships between your content organization a ### Index Pages: `_index.md` -`_index.md` has a special role in Hugo. It allows you to add front matter and content to your [list templates][lists]. These templates include those for [section templates][], [taxonomy templates][], [taxonomy terms templates][], and your [homepage template][]. +`_index.md` has a special role in Hugo. It allows you to add front matter and content to your [list templates][lists]. These templates include those for [section templates], [taxonomy templates], [taxonomy terms templates], and your [homepage template]. {{% note %}} **Tip:** You can get a reference to the content and metadata in `_index.md` using the [`.Site.GetPage` function](/functions/getpage/). diff --git a/content/en/content-management/sections.md b/content/en/content-management/sections.md index 4335f137d..5ff884610 100644 --- a/content/en/content-management/sections.md +++ b/content/en/content-management/sections.md @@ -86,11 +86,11 @@ Also see [Page Variables](/variables/page/). ## Content Section Lists -Hugo will automatically create a page for each *root section* that lists all the content in that section. See the documentation on [section templates][] for details on customizing the way these pages are rendered. +Hugo will automatically create a page for each *root section* that lists all the content in that section. See the documentation on [section templates] for details on customizing the way these pages are rendered. ## Content *Section* vs Content *Type* -By default, everything created within a section will use the [content `type`][content type] that matches the *root section* name. For example, Hugo will assume that `posts/post-1.md` has a `posts` content `type`. If you are using an [archetype][] for your `posts` section, Hugo will generate front matter according to what it finds in `archetypes/posts.md`. +By default, everything created within a section will use the [content `type`][content type] that matches the *root section* name. For example, Hugo will assume that `posts/post-1.md` has a `posts` content `type`. If you are using an [archetype] for your `posts` section, Hugo will generate front matter according to what it finds in `archetypes/posts.md`. [archetype]: /content-management/archetypes/ [content type]: /content-management/types/ diff --git a/content/en/content-management/shortcodes.md b/content/en/content-management/shortcodes.md index 4bc425ff3..634444684 100644 --- a/content/en/content-management/shortcodes.md +++ b/content/en/content-management/shortcodes.md @@ -214,7 +214,7 @@ To see even more options for adding syntax-highlighted code blocks to your websi ### `instagram` -If you'd like to embed a photo from [Instagram][], you only need the photo's ID. You can discern an Instagram photo ID from the URL: +If you'd like to embed a photo from [Instagram], you only need the photo's ID. You can discern an Instagram photo ID from the URL: ```txt https://www.instagram.com/p/BWNjjyYFxVx/ @@ -329,7 +329,7 @@ Using the preceding `tweet` example, the following simulates the displayed exper ### `vimeo` -Adding a video from [Vimeo][] is equivalent to the [YouTube Input shortcode][]. +Adding a video from [Vimeo] is equivalent to the [YouTube Input shortcode]. ```txt https://vimeo.com/channels/staffpicks/146022717 @@ -367,7 +367,7 @@ Using the preceding `vimeo` example, the following simulates the displayed exper ### `youtube` -The `youtube` shortcode embeds a responsive video player for [YouTube videos][]. Only the ID of the video is required, e.g.: +The `youtube` shortcode embeds a responsive video player for [YouTube videos]. Only the ID of the video is required, e.g.: ```txt https://www.youtube.com/watch?v=w7Ft2ymGmfc @@ -410,11 +410,11 @@ Using the preceding `youtube` example (without `autoplay="true"`), the following ## Privacy Config -To learn how to configure your Hugo site to meet the new EU privacy regulation, see [Hugo and the GDPR][]. +To learn how to configure your Hugo site to meet the new EU privacy regulation, see [Hugo and the GDPR]. ## Create Custom Shortcodes -To learn more about creating custom shortcodes, see the [shortcode template documentation][]. +To learn more about creating custom shortcodes, see the [shortcode template documentation]. [`figure` shortcode]: #figure [contentmanagementsection]: /content-management/formats/ diff --git a/content/en/content-management/static-files.md b/content/en/content-management/static-files.md index 946919f0a..20a1442e6 100644 --- a/content/en/content-management/static-files.md +++ b/content/en/content-management/static-files.md @@ -18,7 +18,7 @@ all **static files** (e.g. stylesheets, JavaScript, images). The static files ar Hugo can be configured to look into a different directory, or even **multiple directories** for such static files by configuring the -`staticDir` parameter in the [site config][]. All the files in all the +`staticDir` parameter in the [site config]. All the files in all the static directories will form a union filesystem. This union filesystem will be served from your site root. So a file @@ -62,7 +62,7 @@ Note 1 can be seen in the Norwegian site case). Note 2 -: The example above is a [multihost setup][]. In a regular setup, all +: The example above is a [multihost setup]. In a regular setup, all the static directories will be available to all sites. [site config]: /getting-started/configuration/#all-configuration-settings diff --git a/content/en/content-management/summaries.md b/content/en/content-management/summaries.md index 010e55dcd..345e2f748 100644 --- a/content/en/content-management/summaries.md +++ b/content/en/content-management/summaries.md @@ -81,7 +81,7 @@ Hugo uses the _first_ of the above steps that returns text. So if, for example, ## Example: First 10 Articles with Summaries -You can show content summaries with the following code. You could use the following snippet, for example, in a [section template][]. +You can show content summaries with the following code. You could use the following snippet, for example, in a [section template]. {{< code file="page-list-with-summaries.html" >}} {{ range first 10 .Pages }} diff --git a/content/en/content-management/taxonomies.md b/content/en/content-management/taxonomies.md index 625347203..f5960367f 100644 --- a/content/en/content-management/taxonomies.md +++ b/content/en/content-management/taxonomies.md @@ -40,7 +40,7 @@ Let's assume you are making a website about movies. You may want to include the * Year * Awards -Then, in each of the movies, you would specify terms for each of these taxonomies (i.e., in the [front matter][] of each of your movie content files). From these terms, Hugo would automatically create pages for each Actor, Director, Studio, Genre, Year, and Award, with each listing all of the Movies that matched that specific Actor, Director, Studio, Genre, Year, and Award. +Then, in each of the movies, you would specify terms for each of these taxonomies (i.e., in the [front matter] of each of your movie content files). From these terms, Hugo would automatically create pages for each Actor, Director, Studio, Genre, Year, and Award, with each listing all of the Movies that matched that specific Actor, Director, Studio, Genre, Year, and Award. ### Movie Taxonomy Organization @@ -99,10 +99,10 @@ disableKinds = ["taxonomy","term"] ### Default Destinations -When taxonomies are used---and [taxonomy templates][] are provided---Hugo will automatically create both a page listing all the taxonomy's terms and individual pages with lists of content associated with each term. For example, a `categories` taxonomy declared in your configuration and used in your content front matter will create the following pages: +When taxonomies are used---and [taxonomy templates] are provided---Hugo will automatically create both a page listing all the taxonomy's terms and individual pages with lists of content associated with each term. For example, a `categories` taxonomy declared in your configuration and used in your content front matter will create the following pages: -* A single page at `example.com/categories/` that lists all the [terms within the taxonomy][] -* [Individual taxonomy list pages][taxonomy templates] (e.g., `/categories/development/`) for each of the terms that shows a listing of all pages marked as part of that taxonomy within any content file's [front matter][] +* A single page at `example.com/categories/` that lists all the [terms within the taxonomy] +* [Individual taxonomy list pages][taxonomy templates] (e.g., `/categories/development/`) for each of the terms that shows a listing of all pages marked as part of that taxonomy within any content file's [front matter] ## Configure Taxonomies @@ -146,9 +146,9 @@ You can now use `.Page.Title` on the relevant taxonomy node to get the original ## Add Taxonomies to Content -Once a taxonomy is defined at the site level, any piece of content can be assigned to it, regardless of [content type][] or [content section][]. +Once a taxonomy is defined at the site level, any piece of content can be assigned to it, regardless of [content type] or [content section]. -Assigning content to a taxonomy is done in the [front matter][]. Simply create a variable with the *plural* name of the taxonomy and assign all terms you want to apply to the instance of the content type. +Assigning content to a taxonomy is done in the [front matter]. Simply create a variable with the *plural* name of the taxonomy and assign all terms you want to apply to the instance of the content type. {{% note %}} If you would like the ability to quickly generate content files with preconfigured taxonomies or terms, read the docs on [Hugo archetypes](/content-management/archetypes/). @@ -167,7 +167,7 @@ project_url = "https://github.com/gohugoio/hugo" ## Order Taxonomies -A content file can assign weight for each of its associate taxonomies. Taxonomic weight can be used for sorting or ordering content in [taxonomy list templates][] and is declared in a content file's [front matter][]. The convention for declaring taxonomic weight is `taxonomyname_weight`. +A content file can assign weight for each of its associate taxonomies. Taxonomic weight can be used for sorting or ordering content in [taxonomy list templates] and is declared in a content file's [front matter]. The convention for declaring taxonomic weight is `taxonomyname_weight`. The following show a piece of content that has a weight of 22, which can be used for ordering purposes when rendering the pages assigned to the "a", "b" and "c" values of the `tags` taxonomy. It has also been assigned the weight of 44 when rendering the "d" category page. diff --git a/content/en/content-management/toc.md b/content/en/content-management/toc.md index 6cb8e55bf..d136972cc 100644 --- a/content/en/content-management/toc.md +++ b/content/en/content-management/toc.md @@ -47,7 +47,7 @@ The built-in `.TableOfContents` variables outputs a `