From d7b043f954f05e6effbe51764ccf6e76b1a128c7 Mon Sep 17 00:00:00 2001 From: Joe Mooring Date: Sun, 11 Feb 2024 14:49:31 -0800 Subject: [PATCH] Capitalize the word Markdown throughout the documentation Closes #2435 --- content/en/_index.md | 2 +- .../en/content-management/_common/_index.md | 2 +- content/en/content-management/archetypes.md | 2 +- .../en/content-management/cross-references.md | 2 +- content/en/content-management/diagrams.md | 2 +- content/en/content-management/formats.md | 8 +++--- .../content-management/markdown-attributes.md | 8 +++--- content/en/content-management/mathematics.md | 10 +++---- content/en/content-management/page-bundles.md | 2 +- .../en/content-management/page-resources.md | 6 ++-- content/en/content-management/shortcodes.md | 4 +-- content/en/content-management/urls.md | 2 +- content/en/functions/_common/_index.md | 2 +- content/en/functions/diagrams/Goat.md | 4 +-- content/en/functions/fmt/_common/_index.md | 2 +- .../functions/go-template/_common/_index.md | 2 +- content/en/functions/images/_common/_index.md | 2 +- .../en/functions/resources/_common/_index.md | 2 +- .../en/functions/strings/FindRESubmatch.md | 2 +- content/en/functions/strings/Trim.md | 2 +- content/en/functions/time/_common/_index.md | 2 +- content/en/functions/transform/Markdownify.md | 6 ++-- content/en/functions/urls/Anchorize.md | 4 +-- content/en/functions/urls/_common/_index.md | 2 +- .../getting-started/configuration-markup.md | 28 +++++++++---------- .../en/getting-started/directory-structure.md | 2 +- content/en/getting-started/glossary.md | 10 +++---- content/en/getting-started/quick-start.md | 4 +-- content/en/installation/_common/_index.md | 2 +- content/en/methods/_common/_index.md | 2 +- .../en/methods/menu-entry/_common/_index.md | 2 +- content/en/methods/page/Content.md | 2 +- content/en/methods/page/Fragments.md | 2 +- content/en/methods/page/Plain.md | 2 +- content/en/methods/page/RenderShortcodes.md | 8 +++--- content/en/methods/page/Scratch.md | 2 +- content/en/methods/page/Store.md | 2 +- content/en/methods/page/Summary.md | 2 +- content/en/methods/page/TableOfContents.md | 2 +- content/en/methods/page/Truncated.md | 2 +- content/en/methods/page/_common/_index.md | 2 +- content/en/methods/pages/_common/_index.md | 2 +- content/en/methods/resource/_common/_index.md | 2 +- content/en/methods/shortcode/Get.md | 2 +- content/en/methods/shortcode/Inner.md | 10 +++---- content/en/methods/shortcode/InnerDeindent.md | 6 ++-- content/en/methods/taxonomy/_common/_index.md | 2 +- content/en/quick-reference/emojis.md | 6 ++-- content/en/render-hooks/_index.md | 4 +-- content/en/render-hooks/code-blocks.md | 4 +-- content/en/render-hooks/headings.md | 6 ++-- content/en/render-hooks/images.md | 14 +++++----- content/en/render-hooks/introduction.md | 10 +++---- content/en/render-hooks/links.md | 10 +++---- content/en/showcase/keycdn/index.md | 2 +- .../index.md | 2 +- content/en/templates/lists/index.md | 2 +- content/en/tools/other.md | 2 +- content/en/tools/search.md | 2 +- content/en/troubleshooting/audit/index.md | 2 +- content/en/troubleshooting/faq.md | 4 +-- 61 files changed, 126 insertions(+), 126 deletions(-) diff --git a/content/en/_index.md b/content/en/_index.md index 69d40ebcf62..96ba0c4132a 100644 --- a/content/en/_index.md +++ b/content/en/_index.md @@ -15,7 +15,7 @@ features: - heading: Shortcodes image_path: /images/icon-shortcodes.svg tagline: Hugo's shortcodes are Markdown's hidden superpower. - copy: We love the beautiful simplicity of markdown’s syntax, but there are times when we want more flexibility. Hugo shortcodes allow for both beauty and flexibility. + copy: We love the beautiful simplicity of Markdown’s syntax, but there are times when we want more flexibility. Hugo shortcodes allow for both beauty and flexibility. - heading: Built-in Templates image_path: /images/icon-built-in-templates.svg diff --git a/content/en/content-management/_common/_index.md b/content/en/content-management/_common/_index.md index 47d5812fba5..4328d4d145b 100644 --- a/content/en/content-management/_common/_index.md +++ b/content/en/content-management/_common/_index.md @@ -7,7 +7,7 @@ cascade: --- diff --git a/content/en/content-management/archetypes.md b/content/en/content-management/archetypes.md index 663e409f0a0..9f9dff1457f 100644 --- a/content/en/content-management/archetypes.md +++ b/content/en/content-management/archetypes.md @@ -15,7 +15,7 @@ aliases: [/content/archetypes/] ## Overview -A content file consists of [front matter] and markup. The markup is typically markdown, but Hugo also supports other [content formats]. Front matter can be TOML, YAML, or JSON. +A content file consists of [front matter] and markup. The markup is typically Markdown, but Hugo also supports other [content formats]. Front matter can be TOML, YAML, or JSON. The `hugo new content` command creates a new file in the `content` directory, using an archetype as a template. This is the default archetype: diff --git a/content/en/content-management/cross-references.md b/content/en/content-management/cross-references.md index 500e388a41d..405afea162a 100644 --- a/content/en/content-management/cross-references.md +++ b/content/en/content-management/cross-references.md @@ -60,7 +60,7 @@ index.md can be reference either by its path or by its containing folder without {{}} // <- References /products/index.md ``` -To generate a hyperlink using `ref` or `relref` in markdown: +To generate a hyperlink using `ref` or `relref` in Markdown: ```text [About]({{}} "About Us") diff --git a/content/en/content-management/diagrams.md b/content/en/content-management/diagrams.md index 1cb723c627a..d1ed96ba302 100644 --- a/content/en/content-management/diagrams.md +++ b/content/en/content-management/diagrams.md @@ -1,6 +1,6 @@ --- title: Diagrams -description: Use fenced code blocks and markdown render hooks to display diagrams. +description: Use fenced code blocks and Markdown render hooks to display diagrams. categories: [content management] keywords: [diagrams,drawing] menu: diff --git a/content/en/content-management/formats.md b/content/en/content-management/formats.md index 76c8102b5f6..38a073c1abc 100644 --- a/content/en/content-management/formats.md +++ b/content/en/content-management/formats.md @@ -24,7 +24,7 @@ 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/).| +| 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.| @@ -63,7 +63,7 @@ Some Asciidoctor parameters can be customized in Hugo. See [details]. [details]: /getting-started/configuration-markup/#asciidoc -## Learn markdown +## Learn Markdown Markdown syntax is simple enough to learn in a single sitting. The following are excellent resources to get you up and running: @@ -75,8 +75,8 @@ Markdown syntax is simple enough to learn in a single sitting. The following are [ascii]: https://asciidoctor.org/ [config]: /getting-started/configuration/ [developer tools]: /tools/ -[fireball]: https://daringfireball.net/projects/markdown/ -[gfmtasks]: https://guides.github.com/features/mastering-markdown/#syntax +[fireball]: https://daringfireball.net/projects/Markdown/ +[gfmtasks]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#syntax [helperssource]: https://github.com/gohugoio/hugo/blob/77c60a3440806067109347d04eb5368b65ea0fe8/helpers/general.go#L65 [hl]: /content-management/syntax-highlighting/ [hlsc]: /content-management/shortcodes/#highlight diff --git a/content/en/content-management/markdown-attributes.md b/content/en/content-management/markdown-attributes.md index 29649cede09..3c85679a0ff 100644 --- a/content/en/content-management/markdown-attributes.md +++ b/content/en/content-management/markdown-attributes.md @@ -1,6 +1,6 @@ --- title: Markdown attributes -description: Use mardown attributes to add HTML attributes when rendering markdown to HTML. +description: Use mardown attributes to add HTML attributes when rendering Markdown to HTML. categories: [content management] keywords: [goldmark,markdown] menu: @@ -13,7 +13,7 @@ toc: true ## Overview -Hugo supports markdown attributes on images and block elements including blockquotes, fenced code blocks, headings, horizontal rules, lists, paragraphs, and tables. +Hugo supports Markdown attributes on images and block elements including blockquotes, fenced code blocks, headings, horizontal rules, lists, paragraphs, and tables. For example: @@ -37,7 +37,7 @@ Hugo renders both of these to: ## Block elements -Update your site configuration to enable markdown attributes for block-level elements. +Update your site configuration to enable Markdown attributes for block-level elements. {{< code-toggle file=hugo >}} [markup.goldmark.parser.attribute] @@ -48,7 +48,7 @@ block = true # default is false ## Standalone images -By default, when the [Goldmark] markdown renderer encounters a standalone image element (no other elements or text on the same line), it wraps the image element within a paragraph element per the [CommonMark specification]. +By default, when the [Goldmark] Markdown renderer encounters a standalone image element (no other elements or text on the same line), it wraps the image element within a paragraph element per the [CommonMark specification]. [CommonMark specification]: https://spec.commonmark.org/current/ [Goldmark]: https://github.com/yuin/goldmark diff --git a/content/en/content-management/mathematics.md b/content/en/content-management/mathematics.md index 740f34926ae..a01a166dce1 100644 --- a/content/en/content-management/mathematics.md +++ b/content/en/content-management/mathematics.md @@ -1,7 +1,7 @@ --- -title: Mathematics in markdown +title: Mathematics in Markdown linkTitle: Mathematics -description: Include mathematical equations and expressions in your markdown using LaTeX or TeX typesetting syntax. +description: Include mathematical equations and expressions in your Markdown using LaTeX or TeX typesetting syntax. categories: [content management] keywords: [chemical,chemistry,latex,math,mathjax,tex,typesetting] menu: @@ -45,11 +45,11 @@ The approach described below avoids reliance on platform-specific features like ## Setup -Follow these instructions to include mathematical equations and expressions in your markdown using LaTeX or TeX typesetting syntax. +Follow these instructions to include mathematical equations and expressions in your Markdown using LaTeX or TeX typesetting syntax. ###### Step 1 -Enable and configure the Goldmark [passthrough extension] in your site configuration. The passthrough extension preserves raw markdown within delimited snippets of text, including the delimiters themselves. +Enable and configure the Goldmark [passthrough extension] in your site configuration. The passthrough extension preserves raw Markdown within delimited snippets of text, including the delimiters themselves. {{< code-toggle file=hugo copy=true >}} [markup.goldmark.extensions.passthrough] @@ -122,7 +122,7 @@ The example above loads the partial template if you have set the `math` paramete ###### Step 4 -Include mathematical equations and expressions in your markdown using LaTeX or TeX typesetting syntax. +Include mathematical equations and expressions in your Markdown using LaTeX or TeX typesetting syntax. {{< code file=content/math-examples.md copy=true >}} This is an inline \(a^*=x-b^*\) equation. diff --git a/content/en/content-management/page-bundles.md b/content/en/content-management/page-bundles.md index 74fc540243a..b2621fcb0e8 100644 --- a/content/en/content-management/page-bundles.md +++ b/content/en/content-management/page-bundles.md @@ -144,7 +144,7 @@ A _Branch Bundle_ is any directory at any hierarchy within the This `_index.md` can also be directly under the `content/` directory. {{% note %}} -Here `md` (markdown) is used just as an example. You can use any file +Here `md` (Markdown) is used just as an example. You can use any file type as a content resource as long as it is a content type recognized by Hugo. {{% /note %}} diff --git a/content/en/content-management/page-resources.md b/content/en/content-management/page-resources.md index 623a9ed2ce3..d4c7d552d32 100644 --- a/content/en/content-management/page-resources.md +++ b/content/en/content-management/page-resources.md @@ -210,7 +210,7 @@ the `Name` and `Title` will be assigned to the resource files as follows: By default, with a multilingual single-host site, Hugo does not duplicate shared page resources when building the site. {{% note %}} -This behavior is limited to markdown content. Shared page resources for other [content formats] are copied into each language bundle. +This behavior is limited to Markdown content. Shared page resources for other [content formats] are copied into each language bundle. [content formats]: /content-management/formats/ {{% /note %}} @@ -289,9 +289,9 @@ public/ This approach reduces build times, storage requirements, bandwidth consumption, and deployment times, ultimately reducing cost. {{% note %}} -To resolve markdown link and image destinations to the correct location, you must use link and image render hooks that capture the page resource with the [`Resources.Get`] method, and then invoke its [`RelPermalink`] method. +To resolve Markdown link and image destinations to the correct location, you must use link and image render hooks that capture the page resource with the [`Resources.Get`] method, and then invoke its [`RelPermalink`] method. -By default, with multilingual single-host sites, Hugo enables its [embedded link render hook] and [embedded image render hook] to resolve markdown link and image destinations. +By default, with multilingual single-host sites, Hugo enables its [embedded link render hook] and [embedded image render hook] to resolve Markdown link and image destinations. You may override the embedded render hooks as needed, provided they capture the resource as described above. diff --git a/content/en/content-management/shortcodes.md b/content/en/content-management/shortcodes.md index f12fc46b09b..93487af5c6b 100644 --- a/content/en/content-management/shortcodes.md +++ b/content/en/content-management/shortcodes.md @@ -54,11 +54,11 @@ You can pass multiple lines as parameters to a shortcode by using raw string lit and a new line with a "quoted string".` */>}} ``` -### Shortcodes with markdown +### Shortcodes with Markdown Shortcodes using the `%` as the outer-most delimiter will be fully rendered when sent to the content renderer. This means that the rendered output from a shortcode can be part of the page's table of contents, footnotes, etc. -### Shortcodes without markdown +### Shortcodes without Markdown The `<` character indicates that the shortcode's inner content does *not* need further rendering. Often shortcodes without Markdown include internal HTML: diff --git a/content/en/content-management/urls.md b/content/en/content-management/urls.md index 12efc207f51..c53acdfca30 100644 --- a/content/en/content-management/urls.md +++ b/content/en/content-management/urls.md @@ -307,7 +307,7 @@ Hugo provides two mutually exclusive configuration options to alter URLs _after_ #### Canonical URLs {{% note %}} -This is a legacy configuration option, superseded by template functions and markdown render hooks, and will likely be [removed in a future release]. +This is a legacy configuration option, superseded by template functions and Markdown render hooks, and will likely be [removed in a future release]. [removed in a future release]: https://github.com/gohugoio/hugo/issues/4733 {{% /note %}} diff --git a/content/en/functions/_common/_index.md b/content/en/functions/_common/_index.md index 47d5812fba5..4328d4d145b 100644 --- a/content/en/functions/_common/_index.md +++ b/content/en/functions/_common/_index.md @@ -7,7 +7,7 @@ cascade: --- diff --git a/content/en/functions/diagrams/Goat.md b/content/en/functions/diagrams/Goat.md index cca19ecd2ec..69a099bb778 100644 --- a/content/en/functions/diagrams/Goat.md +++ b/content/en/functions/diagrams/Goat.md @@ -34,7 +34,7 @@ Hugo natively supports [GoAT](https://github.com/bep/goat) diagrams with an [emb [embedded code block render hook]: {{% eturl render-codeblock-goat %}} -This markdown: +This Markdown: ```` ```goat @@ -83,7 +83,7 @@ By way of example, let's create a code block render hook to render GoAT diagrams {{< /code >}} -This markdown: +This Markdown: {{< code file=content/example.md lang=text >}} ```goat {class="foo" caption="Diagram 1: Example"} diff --git a/content/en/functions/fmt/_common/_index.md b/content/en/functions/fmt/_common/_index.md index 47d5812fba5..4328d4d145b 100644 --- a/content/en/functions/fmt/_common/_index.md +++ b/content/en/functions/fmt/_common/_index.md @@ -7,7 +7,7 @@ cascade: --- diff --git a/content/en/functions/go-template/_common/_index.md b/content/en/functions/go-template/_common/_index.md index 47d5812fba5..4328d4d145b 100644 --- a/content/en/functions/go-template/_common/_index.md +++ b/content/en/functions/go-template/_common/_index.md @@ -7,7 +7,7 @@ cascade: --- diff --git a/content/en/functions/images/_common/_index.md b/content/en/functions/images/_common/_index.md index 47d5812fba5..4328d4d145b 100644 --- a/content/en/functions/images/_common/_index.md +++ b/content/en/functions/images/_common/_index.md @@ -7,7 +7,7 @@ cascade: --- diff --git a/content/en/functions/resources/_common/_index.md b/content/en/functions/resources/_common/_index.md index b57b688b310..cb36fea41a9 100644 --- a/content/en/functions/resources/_common/_index.md +++ b/content/en/functions/resources/_common/_index.md @@ -6,7 +6,7 @@ _build: --- diff --git a/content/en/functions/strings/FindRESubmatch.md b/content/en/functions/strings/FindRESubmatch.md index 302d1d9b4f0..3feb15bbdf4 100644 --- a/content/en/functions/strings/FindRESubmatch.md +++ b/content/en/functions/strings/FindRESubmatch.md @@ -30,7 +30,7 @@ By default, `findRESubmatch` finds all matches. You can limit the number of matc ## Practical example -This markdown: +This Markdown: ```text - [Example](https://example.org) diff --git a/content/en/functions/strings/Trim.md b/content/en/functions/strings/Trim.md index 6dfac024b1e..9a87ff20680 100644 --- a/content/en/functions/strings/Trim.md +++ b/content/en/functions/strings/Trim.md @@ -32,7 +32,7 @@ To remove leading and trailing newline characters and carriage returns: The `strings.Trim` function is commonly used in shortcodes to remove leading and trailing newlines characters and carriage returns from the content within the opening and closing shortcode tags. -For example, with this markdown: +For example, with this Markdown: ```text {{}} diff --git a/content/en/functions/time/_common/_index.md b/content/en/functions/time/_common/_index.md index 47d5812fba5..4328d4d145b 100644 --- a/content/en/functions/time/_common/_index.md +++ b/content/en/functions/time/_common/_index.md @@ -7,7 +7,7 @@ cascade: --- diff --git a/content/en/functions/transform/Markdownify.md b/content/en/functions/transform/Markdownify.md index bc2eaee481f..7a84f43b744 100644 --- a/content/en/functions/transform/Markdownify.md +++ b/content/en/functions/transform/Markdownify.md @@ -1,6 +1,6 @@ --- title: transform.Markdownify -description: Renders markdown to HTML. +description: Renders Markdown to HTML. categories: [] keywords: [] action: @@ -24,8 +24,8 @@ To keep the wrapping `p` tags for a single paragraph, use the [`RenderString`] m [`RenderString`]: /methods/page/renderstring/ {{% note %}} -Although the `markdownify` function honors [markdown render hooks] when rendering markdown to HTML, use the `RenderString` method instead of `markdownify` if a render hook accesses `.Page` context. See issue [#9692] for details. +Although the `markdownify` function honors [Markdown render hooks] when rendering Markdown to HTML, use the `RenderString` method instead of `markdownify` if a render hook accesses `.Page` context. See issue [#9692] for details. -[markdown render hooks]: /render-hooks/ +[Markdown render hooks]: /render-hooks/ [#9692]: https://github.com/gohugoio/hugo/issues/9692 {{% /note %}} diff --git a/content/en/functions/urls/Anchorize.md b/content/en/functions/urls/Anchorize.md index 72b3d54a9eb..f3939675a7c 100644 --- a/content/en/functions/urls/Anchorize.md +++ b/content/en/functions/urls/Anchorize.md @@ -16,14 +16,14 @@ aliases: [/functions/anchorize] ## Sanitizing logic -With the default markdown renderer, Goldmark, the sanitizing logic is controlled by your site configuration: +With the default Markdown renderer, Goldmark, the sanitizing logic is controlled by your site configuration: {{< code-toggle file=hugo >}} [markup.goldmark.parser] autoHeadingIDType = 'github' {{< /code-toggle >}} -This controls the behavior of the `anchorize` function and the generation of heading IDs when rendering markdown to HTML. +This controls the behavior of the `anchorize` function and the generation of heading IDs when rendering Markdown to HTML. Set `autoHeadingIDType` to one of: diff --git a/content/en/functions/urls/_common/_index.md b/content/en/functions/urls/_common/_index.md index 47d5812fba5..4328d4d145b 100644 --- a/content/en/functions/urls/_common/_index.md +++ b/content/en/functions/urls/_common/_index.md @@ -7,7 +7,7 @@ cascade: --- diff --git a/content/en/getting-started/configuration-markup.md b/content/en/getting-started/configuration-markup.md index ff0eace253c..092073f447d 100644 --- a/content/en/getting-started/configuration-markup.md +++ b/content/en/getting-started/configuration-markup.md @@ -14,16 +14,16 @@ toc: true ## Default handler -Hugo uses [Goldmark] to render markdown to HTML. +Hugo uses [Goldmark] to render Markdown to HTML. {{< code-toggle file=hugo >}} [markup] defaultMarkdownHandler = 'goldmark' {{< /code-toggle >}} -Files with the `.md` or `.markdown` extension are processed as markdown, provided that you have not specified a different [content format] using the `markup` field in front matter. +Files with the `.md` or `.markdown` extension are processed as Markdown, provided that you have not specified a different [content format] using the `markup` field in front matter. -To use a different renderer for markdown files, specify one of `asciidocext`, `org`, `pandoc`, or `rst` in your site configuration. +To use a different renderer for Markdown files, specify one of `asciidocext`, `org`, `pandoc`, or `rst` in your site configuration. defaultMarkdownHandler|Description :--|:-- @@ -36,7 +36,7 @@ defaultMarkdownHandler|Description To use Asciidoc, Pandoc, or reStructuredText you must install the relevant renderer and update your [security policy]. {{% note %}} -Unless you need a unique capability provided by one of the alternate markdown handlers, we strongly recommend that you use the default setting. Goldmark is fast, well maintained, conforms to the [CommonMark] specification, and is compatible with [GitHub Flavored Markdown] (GFM). +Unless you need a unique capability provided by one of the alternate Markdown handlers, we strongly recommend that you use the default setting. Goldmark is fast, well maintained, conforms to the [CommonMark] specification, and is compatible with [GitHub Flavored Markdown] (GFM). [commonmark]: https://spec.commonmark.org/0.30/ [github flavored markdown]: https://github.github.com/gfm/ @@ -52,7 +52,7 @@ Unless you need a unique capability provided by one of the alternate markdown ha ## Goldmark -This is the default configuration for the Goldmark markdown renderer: +This is the default configuration for the Goldmark Markdown renderer: {{< code-toggle config=markup.goldmark />}} @@ -60,9 +60,9 @@ This is the default configuration for the Goldmark markdown renderer: The extensions below, excluding passthrough, are enabled by default. -Enable the passthrough extension if you include mathematical equations and expressions in your markdown using LaTeX or TeX typesetting syntax. See [mathematics in markdown] for details. +Enable the passthrough extension if you include mathematical equations and expressions in your Markdown using LaTeX or TeX typesetting syntax. See [mathematics in Markdown] for details. -[mathematics in markdown]: content-management/mathematics/ +[mathematics in Markdown]: content-management/mathematics/ Extension|Documentation :--|:-- @@ -122,7 +122,7 @@ With multilingual single-host sites, setting this parameter to `false` will enab ###### parser.wrapStandAloneImageWithinParagraph -(`bool`) If `true`, image elements without adjacent content will be wrapped within a `p` element when rendered. This is the default markdown behavior. Set to `false` when using an [image render hook] to render standalone images as `figure` elements. Default is `true`. +(`bool`) If `true`, image elements without adjacent content will be wrapped within a `p` element when rendered. This is the default Markdown behavior. Set to `false` when using an [image render hook] to render standalone images as `figure` elements. Default is `true`. [image render hook]: /render-hooks/images/ @@ -132,19 +132,19 @@ With multilingual single-host sites, setting this parameter to `false` will enab - `github` produces GitHub-compatible `id` attributes - `github-ascii` drops any non-ASCII characters after accent normalization -- `blackfriday` produces `id` attributes compatible with the Blackfriday markdown renderer +- `blackfriday` produces `id` attributes compatible with the Blackfriday Markdown renderer This is also the strategy used by the [anchorize](/functions/urls/anchorize) template function. Default is `github`. ###### parser.attribute.block -(`bool`) If `true`, enables [markdown attributes] for block elements. Default is `false`. +(`bool`) If `true`, enables [Markdown attributes] for block elements. Default is `false`. -[markdown attributes]: /content-management/markdown-attributes/ +[Markdown attributes]: /content-management/markdown-attributes/ ###### parser.attribute.title -(`bool`) If `true`, enables [markdown attributes] for headings. Default is `true`. +(`bool`) If `true`, enables [Markdown attributes] for headings. Default is `true`. ###### renderHooks.image.enableDefault @@ -180,11 +180,11 @@ The embedded link render hook is automatically enabled for multilingual single-h ###### renderer.unsafe -(`bool`) If `true`, Goldmark renders raw HTML mixed within the markdown. This is unsafe unless the content is under your control. Default is `false`. +(`bool`) If `true`, Goldmark renders raw HTML mixed within the Markdown. This is unsafe unless the content is under your control. Default is `false`. ## Asciidoc -This is the default configuration for the AsciiDoc markdown renderer: +This is the default configuration for the AsciiDoc Markdown renderer: {{< code-toggle config=markup.asciidocExt />}} diff --git a/content/en/getting-started/directory-structure.md b/content/en/getting-started/directory-structure.md index f91849375df..c3865189aab 100644 --- a/content/en/getting-started/directory-structure.md +++ b/content/en/getting-started/directory-structure.md @@ -88,7 +88,7 @@ config : The `config` directory contains your site configuration, possibly split into multiple subdirectories and files. For projects with minimal configuration or projects that do not need to behave differently in different environments, a single configuration file named `hugo.toml` in the root of the project is sufficient. See [details](/getting-started/configuration/#configuration-directory). content -: The `content` directory contains the markup files (typically markdown) and page resources that comprise the content of your site. See [details](/content-management/organization/). +: The `content` directory contains the markup files (typically Markdown) and page resources that comprise the content of your site. See [details](/content-management/organization/). data : The `data` directory contains data files (JSON, TOML, YAML, or XML) that augment content, configuration, localization, and navigation. See [details](/templates/data-templates/). diff --git a/content/en/getting-started/glossary.md b/content/en/getting-started/glossary.md index cb5ffd43c15..ceec3ae4f51 100644 --- a/content/en/getting-started/glossary.md +++ b/content/en/getting-started/glossary.md @@ -86,7 +86,7 @@ An [array](#array), [slice](#slice), or [map](#map). ###### content format -A markup language for creating content. Typically markdown, but may also be HTML, AsciiDoc, Org, Pandoc, or reStructuredText. See [details](/content-management/formats/). +A markup language for creating content. Typically Markdown, but may also be HTML, AsciiDoc, Org, Pandoc, or reStructuredText. See [details](/content-management/formats/). ###### content type @@ -206,9 +206,9 @@ Adaptation of a site to meet language and regional requirements. This includes t An unordered group of elements, each indexed by a unique key. See the [Go documentation](https://go.dev/ref/spec#Map_types) for details. -###### markdown attribute +###### Markdown attribute -A list of attributes, containing one or more key/value pairs, separated by spaces or commas, and wrapped by braces. Apply markdown attributes to images and block-level elements including blockquotes, fenced code blocks, headings, horizontal rules, lists, paragraphs, and tables. See [details](/getting-started/configuration-markup/#goldmark). +A list of attributes, containing one or more key/value pairs, separated by spaces or commas, and wrapped by braces. Apply Markdown attributes to images and block-level elements including blockquotes, fenced code blocks, headings, horizontal rules, lists, paragraphs, and tables. See [details](/getting-started/configuration-markup/#goldmark). ###### marshal @@ -309,7 +309,7 @@ The host-relative URL of a published resource or a rendered page. ###### render hook -A [template](#template) that overrides standard markdown rendering. See [details](/render-hooks). +A [template](#template) that overrides standard Markdown rendering. See [details](/render-hooks). ###### remote resource @@ -343,7 +343,7 @@ Content with the "section" [page kind](#page-kind). Typically a listing of [regu ###### shortcode -A [template](#template) called from within markdown, taking zero or more [arguments](#argument). See [details](/content-management/shortcodes/). +A [template](#template) called from within Markdown, taking zero or more [arguments](#argument). See [details](/content-management/shortcodes/). ###### slice diff --git a/content/en/getting-started/quick-start.md b/content/en/getting-started/quick-start.md index 079c3af6d82..2083bc220df 100644 --- a/content/en/getting-started/quick-start.md +++ b/content/en/getting-started/quick-start.md @@ -125,7 +125,7 @@ draft = true Notice the `draft` value in the [front matter] is `true`. By default, Hugo does not publish draft content when you build the site. Learn more about [draft, future, and expired content]. -Add some [markdown] to the body of the post, but do not change the `draft` value. +Add some [Markdown] to the body of the post, but do not change the `draft` value. [markdown]: https://commonmark.org/help/ @@ -154,7 +154,7 @@ View your site at the URL displayed in your terminal. Keep the development serve When satisfied with your new content, set the front matter `draft` parameter to `false`. {{% note %}} -Hugo's rendering engine conforms to the CommonMark [specification] for markdown. The CommonMark organization provides a useful [live testing tool] powered by the reference implementation. +Hugo's rendering engine conforms to the CommonMark [specification] for Markdown. The CommonMark organization provides a useful [live testing tool] powered by the reference implementation. [live testing tool]: https://spec.commonmark.org/dingus/ [specification]: https://spec.commonmark.org/ diff --git a/content/en/installation/_common/_index.md b/content/en/installation/_common/_index.md index 47d5812fba5..4328d4d145b 100644 --- a/content/en/installation/_common/_index.md +++ b/content/en/installation/_common/_index.md @@ -7,7 +7,7 @@ cascade: --- diff --git a/content/en/methods/_common/_index.md b/content/en/methods/_common/_index.md index 47d5812fba5..4328d4d145b 100644 --- a/content/en/methods/_common/_index.md +++ b/content/en/methods/_common/_index.md @@ -7,7 +7,7 @@ cascade: --- diff --git a/content/en/methods/menu-entry/_common/_index.md b/content/en/methods/menu-entry/_common/_index.md index 47d5812fba5..4328d4d145b 100644 --- a/content/en/methods/menu-entry/_common/_index.md +++ b/content/en/methods/menu-entry/_common/_index.md @@ -7,7 +7,7 @@ cascade: --- diff --git a/content/en/methods/page/Content.md b/content/en/methods/page/Content.md index 40a057f0263..a9d38367c15 100644 --- a/content/en/methods/page/Content.md +++ b/content/en/methods/page/Content.md @@ -13,7 +13,7 @@ action: signatures: [PAGE.Content] --- -The `Content` method on a `Page` object renders markdown and shortcodes to HTML. The content does not include front matter. +The `Content` method on a `Page` object renders Markdown and shortcodes to HTML. The content does not include front matter. [shortcodes]: /getting-started/glossary/#shortcode diff --git a/content/en/methods/page/Fragments.md b/content/en/methods/page/Fragments.md index 14a3bededbd..11ab50fd893 100644 --- a/content/en/methods/page/Fragments.md +++ b/content/en/methods/page/Fragments.md @@ -21,7 +21,7 @@ In a URL, whether absolute or relative, the [fragment] links to an `id` attribut path fragment ``` -Hugo assigns an `id` attribute to each markdown [ATX] and [setext] heading within the page content. You can override the `id` with a [markdown attribute] as needed. This creates the relationship between an entry in the [table of contents] (TOC) and a heading on the page. +Hugo assigns an `id` attribute to each Markdown [ATX] and [setext] heading within the page content. You can override the `id` with a [Markdown attribute] as needed. This creates the relationship between an entry in the [table of contents] (TOC) and a heading on the page. Use the `Fragments` method on a `Page` object to create a table of contents with the `Fragments.ToHTML` method, or by [walking] the `Fragments.Map` data structure. diff --git a/content/en/methods/page/Plain.md b/content/en/methods/page/Plain.md index 6fdf60b62cf..c99c154f5c0 100644 --- a/content/en/methods/page/Plain.md +++ b/content/en/methods/page/Plain.md @@ -13,7 +13,7 @@ action: signatures: [PAGE.Plain] --- -The `Plain` method on a `Page` object renders markdown and [shortcodes] to HTML, then strips the HTML [tags]. It does not strip HTML [entities]. The plain content does not include front matter. +The `Plain` method on a `Page` object renders Markdown and [shortcodes] to HTML, then strips the HTML [tags]. It does not strip HTML [entities]. The plain content does not include front matter. To prevent Go's [html/template] package from escaping HTML entities, pass the result through the [`htmlUnescape`] function. diff --git a/content/en/methods/page/RenderShortcodes.md b/content/en/methods/page/RenderShortcodes.md index 4636bf8f5ba..d822bc1e123 100644 --- a/content/en/methods/page/RenderShortcodes.md +++ b/content/en/methods/page/RenderShortcodes.md @@ -26,7 +26,7 @@ For example: {{ $p.RenderShortcodes }} {{< /code >}} -Then in your markdown: +Then in your Markdown: {{< code file=content/about.md lang=md >}} {{%/* include "/snippets/services.md" */%}} @@ -34,14 +34,14 @@ Then in your markdown: {{%/* include "/snippets/leadership.md" */%}} {{< /code >}} -Each of the included markdown files can contain calls to other shortcodes. +Each of the included Markdown files can contain calls to other shortcodes. ## Shortcode notation In the example above it's important to understand the difference between the two delimiters used when calling a shortcode: - `{{}}` tells Hugo that the rendered shortcode does not need further processing. For example, the shortcode content is HTML. -- `{{%/* myshortcode */%}}` tells Hugo that the rendered shortcode needs further processing. For example, the shortcode content is markdown. +- `{{%/* myshortcode */%}}` tells Hugo that the rendered shortcode needs further processing. For example, the shortcode content is Markdown. Use the latter for the "include" shortcode described above. @@ -75,4 +75,4 @@ https://example.org/privacy/ An *emphasized* word. ``` -Note that the shortcode within the content file was rendered, but the surrounding markdown was preserved. +Note that the shortcode within the content file was rendered, but the surrounding Markdown was preserved. diff --git a/content/en/methods/page/Scratch.md b/content/en/methods/page/Scratch.md index 527e910952d..55366f405fc 100644 --- a/content/en/methods/page/Scratch.md +++ b/content/en/methods/page/Scratch.md @@ -25,7 +25,7 @@ To create a locally scoped scratch pad that is not attached to a `Page` object, ## Determinate values -The `Scratch` method is often used to set "scratch pad" values within a shortcode, a partial template called by a shortcode, or by a markdown render hook. In all three cases, the "scratch pad" values are not determinate until Hugo renders the page content. +The `Scratch` method is often used to set "scratch pad" values within a shortcode, a partial template called by a shortcode, or by a Markdown render hook. In all three cases, the "scratch pad" values are not determinate until Hugo renders the page content. If you need to access a "scratch pad" value from a parent template, and the parent template has not yet rendered the page content, you can trigger content rendering by assigning the returned value to a noop variable: diff --git a/content/en/methods/page/Store.md b/content/en/methods/page/Store.md index f9b5168c881..47e1cdb3154 100644 --- a/content/en/methods/page/Store.md +++ b/content/en/methods/page/Store.md @@ -106,7 +106,7 @@ Removes the given key. ## Determinate values -The `Store` method is often used to set "scratch pad" values within a shortcode, a partial template called by a shortcode, or by a markdown render hook. In all three cases, the "scratch pad" values are not determinate until Hugo renders the page content. +The `Store` method is often used to set "scratch pad" values within a shortcode, a partial template called by a shortcode, or by a Markdown render hook. In all three cases, the "scratch pad" values are not determinate until Hugo renders the page content. If you need to access a "scratch pad" value from a parent template, and the parent template has not yet rendered the page content, you can trigger content rendering by assigning the returned value to a noop variable: diff --git a/content/en/methods/page/Summary.md b/content/en/methods/page/Summary.md index 6223783b67b..1a4d17bcd66 100644 --- a/content/en/methods/page/Summary.md +++ b/content/en/methods/page/Summary.md @@ -14,7 +14,7 @@ action: There are three ways to define the [content summary]: 1. Let Hugo create the summary based on the first 70 words. You can change the number of words by setting the `summaryLength` in your site configuration. -2. Manually split the content with a `<--more-->` tag in markdown. Everything before the tag is included in the summary. +2. Manually split the content with a `<--more-->` tag in Markdown. Everything before the tag is included in the summary. 3. Create a `summary` field in front matter. To list the pages in a section with a summary beneath each link: diff --git a/content/en/methods/page/TableOfContents.md b/content/en/methods/page/TableOfContents.md index 2ab182e8ca7..7e6216f3558 100644 --- a/content/en/methods/page/TableOfContents.md +++ b/content/en/methods/page/TableOfContents.md @@ -10,7 +10,7 @@ action: signatures: [PAGE.TableOfContents] --- -The `TableOfContents` method on a `Page` object returns an ordered or unordered list of the markdown [ATX] and [setext] headings within the page content. +The `TableOfContents` method on a `Page` object returns an ordered or unordered list of the Markdown [ATX] and [setext] headings within the page content. [atx]: https://spec.commonmark.org/0.30/#atx-headings [setext]: https://spec.commonmark.org/0.30/#setext-headings diff --git a/content/en/methods/page/Truncated.md b/content/en/methods/page/Truncated.md index 4ba7cae2c97..0785f40cb08 100644 --- a/content/en/methods/page/Truncated.md +++ b/content/en/methods/page/Truncated.md @@ -13,7 +13,7 @@ action: There are three ways to define the [content summary]: 1. Let Hugo create the summary based on the first 70 words. You can change the number of words by setting the `summaryLength` in your site configuration. -2. Manually split the content with a `<--more-->` tag in markdown. Everything before the tag is included in the summary. +2. Manually split the content with a `<--more-->` tag in Markdown. Everything before the tag is included in the summary. 3. Create a `summary` field in front matter. {{% note %}} diff --git a/content/en/methods/page/_common/_index.md b/content/en/methods/page/_common/_index.md index 47d5812fba5..4328d4d145b 100644 --- a/content/en/methods/page/_common/_index.md +++ b/content/en/methods/page/_common/_index.md @@ -7,7 +7,7 @@ cascade: --- diff --git a/content/en/methods/pages/_common/_index.md b/content/en/methods/pages/_common/_index.md index 47d5812fba5..4328d4d145b 100644 --- a/content/en/methods/pages/_common/_index.md +++ b/content/en/methods/pages/_common/_index.md @@ -7,7 +7,7 @@ cascade: --- diff --git a/content/en/methods/resource/_common/_index.md b/content/en/methods/resource/_common/_index.md index 47d5812fba5..4328d4d145b 100644 --- a/content/en/methods/resource/_common/_index.md +++ b/content/en/methods/resource/_common/_index.md @@ -7,7 +7,7 @@ cascade: --- diff --git a/content/en/methods/shortcode/Get.md b/content/en/methods/shortcode/Get.md index cd674614f12..1a2ee22e0cb 100644 --- a/content/en/methods/shortcode/Get.md +++ b/content/en/methods/shortcode/Get.md @@ -12,7 +12,7 @@ action: toc: true --- -Specify the parameter by position or by name. When calling a shortcode within markdown, use either positional or named parameters, but not both. +Specify the parameter by position or by name. When calling a shortcode within Markdown, use either positional or named parameters, but not both. {{% note %}} Some shortcodes support positional parameters, some support named parameters, and others support both. Refer to the shortcode's documentation for usage details. diff --git a/content/en/methods/shortcode/Inner.md b/content/en/methods/shortcode/Inner.md index 57fe831872a..2dee2e60eca 100644 --- a/content/en/methods/shortcode/Inner.md +++ b/content/en/methods/shortcode/Inner.md @@ -46,13 +46,13 @@ Is rendered to: ``` {{% note %}} -Content between opening and closing shortcode tags may include leading and/or trailing newlines, depending on placement within the markdown. Use the [`trim`] function as shown above to remove both carriage returns and newlines. +Content between opening and closing shortcode tags may include leading and/or trailing newlines, depending on placement within the Markdown. Use the [`trim`] function as shown above to remove both carriage returns and newlines. [`trim`]: /functions/strings/trim/ {{% /note %}} {{% note %}} -In the example above, the value returned by `Inner` is markdown, but it was rendered as plain text. Use either of the following approaches to render markdown to HTML. +In the example above, the value returned by `Inner` is Markdown, but it was rendered as plain text. Use either of the following approaches to render Markdown to HTML. {{% /note %}} @@ -99,9 +99,9 @@ We design the **best** widgets in the world. {{%/* /card */%}} {{< /code >}} -When you use the `{{%/* */%}}` notation, Hugo renders the entire shortcode as markdown, requiring the following changes. +When you use the `{{%/* */%}}` notation, Hugo renders the entire shortcode as Markdown, requiring the following changes. -First, configure the renderer to allow raw HTML within markdown: +First, configure the renderer to allow raw HTML within Markdown: {{< code-toggle file=hugo >}} [markup.goldmark.renderer] @@ -110,7 +110,7 @@ unsafe = true This configuration is not unsafe if _you_ control the content. Read more about Hugo's [security model]. -Second, because we are rendering the entire shortcode as markdown, we must adhere to the rules governing [indentation] and inclusion of [raw HTML blocks] as provided in the [CommonMark] specification. +Second, because we are rendering the entire shortcode as Markdown, we must adhere to the rules governing [indentation] and inclusion of [raw HTML blocks] as provided in the [CommonMark] specification. {{< code file=layouts/shortcodes/card.html >}}
diff --git a/content/en/methods/shortcode/InnerDeindent.md b/content/en/methods/shortcode/InnerDeindent.md index 56b712ac926..b5f5cf20614 100644 --- a/content/en/methods/shortcode/InnerDeindent.md +++ b/content/en/methods/shortcode/InnerDeindent.md @@ -14,7 +14,7 @@ Similar to the [`Inner`] method, `InnerDeindent` returns the content between ope This allows us to effectively bypass the rules governing [indentation] as provided in the [CommonMark] specification. -Consider this markdown, an unordered list with a small gallery of thumbnail images within each list item: +Consider this Markdown, an unordered list with a small gallery of thumbnail images within each list item: {{< code file=content/about.md lang=md >}} - Gallery one @@ -42,7 +42,7 @@ With this shortcode, calling `Inner` instead of `InnerDeindent`:
{{< /code >}} -Hugo renders the markdown to: +Hugo renders the Markdown to: ```html