Skip to content

Commit

Permalink
Capitalize the word Markdown throughout the documentation
Browse files Browse the repository at this point in the history
Closes #2435
  • Loading branch information
jmooring committed Feb 11, 2024
1 parent 86c1a7c commit 89114bb
Show file tree
Hide file tree
Showing 61 changed files with 126 additions and 126 deletions.
2 changes: 1 addition & 1 deletion content/en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/en/content-management/_common/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ cascade:
---

<!--
Files within this headless branch bundle are markdown snippets. Each file must contain front matter delimiters, though front matter fields are not required.
Files within this headless branch bundle are Markdown snippets. Each file must contain front matter delimiters, though front matter fields are not required.
Include the rendered content using the "include" shortcode.
-->
2 changes: 1 addition & 1 deletion content/en/content-management/archetypes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion content/en/content-management/cross-references.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ index.md can be reference either by its path or by its containing folder without
{{</* ref "/products/index" */>}} // <- 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]({{</* ref "/about" */>}} "About Us")
Expand Down
2 changes: 1 addition & 1 deletion content/en/content-management/diagrams.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
8 changes: 4 additions & 4 deletions content/en/content-management/formats.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.|
Expand Down Expand Up @@ -63,7 +63,7 @@ Some Asciidoctor parameters can be customized in Hugo. See&nbsp;[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:

Expand All @@ -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
Expand Down
8 changes: 4 additions & 4 deletions content/en/content-management/markdown-attributes.md
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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:

Expand All @@ -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]
Expand All @@ -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
Expand Down
10 changes: 5 additions & 5 deletions content/en/content-management/mathematics.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion content/en/content-management/page-bundles.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}}

Expand Down
6 changes: 3 additions & 3 deletions content/en/content-management/page-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}}
Expand Down Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions content/en/content-management/shortcodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion content/en/content-management/urls.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}}
Expand Down
2 changes: 1 addition & 1 deletion content/en/functions/_common/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ cascade:
---

<!--
Files within this headless branch bundle are markdown snippets. Each file must contain front matter delimiters, though front matter fields are not required.
Files within this headless branch bundle are Markdown snippets. Each file must contain front matter delimiters, though front matter fields are not required.
Include the rendered content using the "include" shortcode.
-->
4 changes: 2 additions & 2 deletions content/en/functions/diagrams/Goat.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -83,7 +83,7 @@ By way of example, let's create a code block render hook to render GoAT diagrams
</figure>
{{< /code >}}

This markdown:
This Markdown:

{{< code file=content/example.md lang=text >}}
```goat {class="foo" caption="Diagram 1: Example"}
Expand Down
2 changes: 1 addition & 1 deletion content/en/functions/fmt/_common/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ cascade:
---

<!--
Files within this headless branch bundle are markdown snippets. Each file must contain front matter delimiters, though front matter fields are not required.
Files within this headless branch bundle are Markdown snippets. Each file must contain front matter delimiters, though front matter fields are not required.
Include the rendered content using the "include" shortcode.
-->
2 changes: 1 addition & 1 deletion content/en/functions/go-template/_common/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ cascade:
---

<!--
Files within this headless branch bundle are markdown snippets. Each file must contain front matter delimiters, though front matter fields are not required.
Files within this headless branch bundle are Markdown snippets. Each file must contain front matter delimiters, though front matter fields are not required.
Include the rendered content using the "include" shortcode.
-->
2 changes: 1 addition & 1 deletion content/en/functions/images/_common/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ cascade:
---

<!--
Files within this headless branch bundle are markdown snippets. Each file must contain front matter delimiters, though front matter fields are not required.
Files within this headless branch bundle are Markdown snippets. Each file must contain front matter delimiters, though front matter fields are not required.
Include the rendered content using the "include" shortcode.
-->
2 changes: 1 addition & 1 deletion content/en/functions/resources/_common/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ _build:
---

<!--
Files within this headless branch bundle are markdown snippets. Each file must contain front matter delimiters, though front matter fields are not required.
Files within this headless branch bundle are Markdown snippets. Each file must contain front matter delimiters, though front matter fields are not required.
Include the rendered content using the "include" shortcode.
-->
2 changes: 1 addition & 1 deletion content/en/functions/strings/FindRESubmatch.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion content/en/functions/strings/Trim.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
{{</* my-shortcode */>}}
Expand Down
2 changes: 1 addition & 1 deletion content/en/functions/time/_common/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ cascade:
---

<!--
Files within this headless branch bundle are markdown snippets. Each file must contain front matter delimiters, though front matter fields are not required.
Files within this headless branch bundle are Markdown snippets. Each file must contain front matter delimiters, though front matter fields are not required.
Include the rendered content using the "include" shortcode.
-->
6 changes: 3 additions & 3 deletions content/en/functions/transform/Markdownify.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: transform.Markdownify
description: Renders markdown to HTML.
description: Renders Markdown to HTML.
categories: []
keywords: []
action:
Expand All @@ -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 %}}
4 changes: 2 additions & 2 deletions content/en/functions/urls/Anchorize.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion content/en/functions/urls/_common/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ cascade:
---

<!--
Files within this headless branch bundle are markdown snippets. Each file must contain front matter delimiters, though front matter fields are not required.
Files within this headless branch bundle are Markdown snippets. Each file must contain front matter delimiters, though front matter fields are not required.
Include the rendered content using the "include" shortcode.
-->
Loading

0 comments on commit 89114bb

Please sign in to comment.