From b6cb5ae4830e12b1bd554934c52c1071c3b536c7 Mon Sep 17 00:00:00 2001 From: Christian Oliff Date: Thu, 20 Oct 2022 01:06:32 +0900 Subject: [PATCH] Markdown linting fixes (#1846) --- .cspell.json | 3 +++ .github/workflows/super-linter.yml | 1 - .markdownlint.yaml | 27 +++++++++++++++++-- .markdownlintignore | 5 ++++ content/en/about/benefits.md | 1 - content/en/about/features.md | 1 - content/en/about/hugo-and-gdpr.md | 4 +-- content/en/about/security-model/index.md | 3 +-- content/en/content-management/archetypes.md | 4 --- .../en/content-management/build-options.md | 4 ++- .../en/content-management/cross-references.md | 2 +- content/en/content-management/diagrams.md | 17 ++++-------- content/en/content-management/formats.md | 8 +++--- content/en/content-management/front-matter.md | 14 +++++----- content/en/content-management/multilingual.md | 4 +-- content/en/content-management/page-bundles.md | 19 +++++++------ .../en/content-management/page-resources.md | 5 ++-- content/en/content-management/related.md | 10 ++++--- content/en/content-management/shortcodes.md | 14 ++++------ content/en/content-management/static-files.md | 1 - content/en/content-management/summaries.md | 4 +-- content/en/content-management/types.md | 10 +++---- content/en/content-management/urls.md | 4 +-- content/en/contribute/development.md | 18 ++++++------- content/en/contribute/documentation.md | 2 -- content/en/functions/RenderString.md | 2 +- content/en/functions/complement.md | 5 ---- content/en/functions/dict.md | 10 +++---- content/en/functions/format.md | 2 +- content/en/functions/highlight.md | 4 +-- content/en/functions/int.md | 2 +- content/en/functions/ref.md | 2 +- content/en/functions/relref.md | 2 +- content/en/functions/scratch.md | 2 +- content/en/functions/symdiff.md | 5 ---- content/en/functions/urlize.md | 2 -- content/en/functions/where.md | 2 +- .../getting-started/configuration-markup.md | 2 +- content/en/getting-started/configuration.md | 17 ++++++++---- content/en/getting-started/installing.md | 8 +++--- content/en/getting-started/usage.md | 2 +- .../hosting-on-21yunbox.md | 1 + .../hosting-on-aws-amplify.md | 2 +- .../hosting-on-firebase.md | 5 ++-- .../hosting-on-netlify.md | 1 - .../hosting-on-render.md | 6 ++--- content/en/hugo-modules/configuration.md | 5 +--- content/en/hugo-modules/theme-components.md | 2 +- content/en/hugo-modules/use-modules.md | 1 - content/en/hugo-pipes/babel.md | 1 - content/en/hugo-pipes/introduction.md | 5 +--- content/en/hugo-pipes/minification.md | 3 --- content/en/hugo-pipes/resource-from-string.md | 2 -- .../en/hugo-pipes/resource-from-template.md | 7 ++--- content/en/news/0.89.4-relnotes/index.md | 7 ----- content/en/readfiles/dateformatting.md | 2 +- content/en/templates/alternatives.md | 2 -- content/en/templates/base.md | 1 - content/en/templates/files.md | 4 +-- content/en/templates/internal.md | 1 + content/en/templates/introduction.md | 9 ++++--- content/en/templates/lookup-order.md | 2 +- content/en/templates/menu-templates.md | 1 - content/en/templates/ordering-and-grouping.md | 6 +---- content/en/templates/output-formats.md | 3 ++- content/en/templates/pagination.md | 1 - content/en/templates/partials.md | 2 +- content/en/templates/render-hooks.md | 4 +-- content/en/templates/rss.md | 2 +- content/en/templates/section-templates.md | 1 - content/en/templates/shortcode-templates.md | 9 ++----- content/en/tools/frontends.md | 18 ++++++------- content/en/tools/other.md | 18 ++++++------- content/en/variables/menus.md | 7 +++-- content/en/variables/site.md | 3 --- content/en/variables/sitemap.md | 3 +-- 76 files changed, 178 insertions(+), 223 deletions(-) create mode 100644 .markdownlintignore diff --git a/.cspell.json b/.cspell.json index 51dddc8d3..1fcd48fa0 100644 --- a/.cspell.json +++ b/.cspell.json @@ -82,6 +82,7 @@ "eparis", "errorf", "erroridf", + "esbuild", "Evernote", "Exif", "exitwp", @@ -231,6 +232,7 @@ "Poupin", "prerender", "println", + "Pritchard", "publishdate", "Pygments", "qref", @@ -259,6 +261,7 @@ "safejs", "Samsa", "schemaorg", + "setx", "Shekhar", "Shortcode", "Shortcodes", diff --git a/.github/workflows/super-linter.yml b/.github/workflows/super-linter.yml index 062336a94..80658ebd9 100644 --- a/.github/workflows/super-linter.yml +++ b/.github/workflows/super-linter.yml @@ -33,7 +33,6 @@ jobs: VALIDATE_HTML: false VALIDATE_JAVASCRIPT_STANDARD: false VALIDATE_JSCPD: false - VALIDATE_MARKDOWN: false VALIDATE_NATURAL_LANGUAGE: false VALIDATE_SHELL_SHFMT: false VALIDATE_XML: false diff --git a/.markdownlint.yaml b/.markdownlint.yaml index 1b76d280e..545846ce5 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -1,4 +1,27 @@ # https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md -MD013: false # Line length -MD033: false # Inline HTML +MD002: false +MD003: false +MD004: false +MD007: false +MD012: + maximum: 2 +MD013: false +MD014: false +MD022: false +MD024: false +MD026: false +MD031: false +MD032: false +MD033: false +MD034: false +MD036: false +MD037: false +MD038: false +MD040: false +MD041: false +MD046: false +MD049: false +MD050: false +MD051: false +MD053: false diff --git a/.markdownlintignore b/.markdownlintignore new file mode 100644 index 000000000..43e5b1b1b --- /dev/null +++ b/.markdownlintignore @@ -0,0 +1,5 @@ +**/commands/** +**/news/** +**/showcase/** +**/zh/** +**/license.md diff --git a/content/en/about/benefits.md b/content/en/about/benefits.md index d5c13a9c3..e4fec5bb2 100644 --- a/content/en/about/benefits.md +++ b/content/en/about/benefits.md @@ -34,7 +34,6 @@ This has many benefits. The most noticeable is performance. HTTP servers are *ve * ["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 ["Static Site Generators", O'Reilly]: https://github.com/gohugoio/hugoDocs/files/1242701/static-site-generators.pdf ["Top 10 Static Website Generators", Netlify blog]: https://www.netlify.com/blog/2016/05/02/top-ten-static-website-generators/ diff --git a/content/en/about/features.md b/content/en/about/features.md index ed8c25821..28a5099a9 100644 --- a/content/en/about/features.md +++ b/content/en/about/features.md @@ -54,7 +54,6 @@ toc: true * Support for [Go][] HTML templates * [Syntax highlighting][] powered by [Chroma][] - [aliases]: /content-management/urls/#aliases [Chroma]: https://github.com/alecthomas/chroma [content summaries]: /content-management/summaries/ diff --git a/content/en/about/hugo-and-gdpr.md b/content/en/about/hugo-and-gdpr.md index 81cc5782a..2d4fba872 100644 --- a/content/en/about/hugo-and-gdpr.md +++ b/content/en/about/hugo-and-gdpr.md @@ -16,7 +16,6 @@ aliases: [/privacy/,/gdpr/] toc: true --- - General Data Protection Regulation ([GDPR](https://en.wikipedia.org/wiki/General_Data_Protection_Regulation)) is a regulation in EU law on data protection and privacy for all individuals within the European Union and the European Economic Area. It became enforceable on 25 May 2018. **Hugo is a static site generator. By using Hugo you are already standing on very solid ground. Static HTML files on disk are much easier to reason about compared to server and database driven web sites.** @@ -95,6 +94,7 @@ useSessionStorage {{% warning %}} `useSessionStorage` is not supported when using Google Analytics v4 (gtag.js). {{% /warning %}} + ### Instagram simple @@ -116,7 +116,6 @@ enableDNT simple : If simple mode is enabled, a static and no-JS version of a tweet will be built. - **Note:** If you use the _simple mode_ for Twitter, you may want to disable the inline styles provided by Hugo: {{< code-toggle file="config">}} @@ -137,4 +136,3 @@ enableDNT simple : If simple mode is enabled, the video thumbnail is fetched from Vimeo's servers and it is overlayed with a play button. If the user clicks to play the video, it will open in a new tab directly on Vimeo's website. - diff --git a/content/en/about/security-model/index.md b/content/en/about/security-model/index.md index 461c7fe77..497685cb4 100644 --- a/content/en/about/security-model/index.md +++ b/content/en/about/security-model/index.md @@ -28,7 +28,6 @@ But when developing and building your site, the runtime is the `hugo` executable * User-defined components have read-only access to the filesystem. * We shell out to some external binaries to support [Asciidoctor](/content-management/formats/#list-of-content-formats) and similar, but those binaries and their flags are predefined and disabled by default (see [Security Policy](#security-policy)). General functions to run arbitrary external OS commands have been [discussed](https://github.com/gohugoio/hugo/issues/796), but not implemented because of security concerns. - ## Security Policy {{< new-in "0.91.0" >}} @@ -57,7 +56,7 @@ These are the security threats as defined by [OWASP](https://en.wikipedia.org/wi For HTML output, this is the core security model: -https://golang.org/pkg/html/template/#hdr-Security_Model + In short: diff --git a/content/en/content-management/archetypes.md b/content/en/content-management/archetypes.md index 354ef0fef..cb55fb24d 100644 --- a/content/en/content-management/archetypes.md +++ b/content/en/content-management/archetypes.md @@ -12,7 +12,6 @@ menu: weight: 70 quicklinks: weight: 70 #rem -draft: false aliases: [/content/archetypes/] toc: true --- @@ -69,7 +68,6 @@ It will create a new newsletter type of content file based on the archetype temp The above _newsletter type archetype_ illustrates the possibilities: The full Hugo `.Site` and all of Hugo's template funcs can be used in the archetype file. - ## Directory based archetypes Since Hugo `0.49` you can use complete directories as archetype templates. Given this archetype directory: @@ -90,8 +88,6 @@ hugo new --kind post-bundle posts/my-post Will create a new folder in `/content/posts/my-post` with the same set of files as in the `post-bundle` archetypes folder. All content files (`index.md` etc.) can contain template logic, and will receive the correct `.Site` for the content's language. - - [archetypes directory]: /getting-started/directory-structure/ [content types]: /content-management/types/ [front matter]: /content-management/front-matter/ diff --git a/content/en/content-management/build-options.md b/content/en/content-management/build-options.md index 7bbb772df..16954eae2 100644 --- a/content/en/content-management/build-options.md +++ b/content/en/content-management/build-options.md @@ -26,6 +26,7 @@ _build: {{< /code-toggle >}} #### render + If `always`, the page will be treated as a published page, holding its dedicated output files (`index.html`, etc...) and permalink. {{< new-in "0.76.0" >}} We extended this property from a boolean to an enum in Hugo 0.76.0. Valid values are: @@ -58,7 +59,7 @@ If true, the page will be treated as part of the project's collections and, when #### publishResources -If set to true the [Bundle's Resources]({{< relref "content-management/page-bundles" >}}) will be published. +If set to true the [Bundle's Resources]({{< relref "content-management/page-bundles" >}}) will be published. Setting this to false will still publish Resources on demand (when a resource's `.Permalink` or `.RelPermalink` is invoked from the templates) but will skip the others. {{% note %}} @@ -70,6 +71,7 @@ Any page, regardless of their build options, will always be available using the ### Illustrative use cases #### Not publishing a page + Project needs a "Who We Are" content file for Front Matter and body to be used by the homepage but nowhere else. ```yaml diff --git a/content/en/content-management/cross-references.md b/content/en/content-management/cross-references.md index b5dd8a4c3..5ec7dc545 100644 --- a/content/en/content-management/cross-references.md +++ b/content/en/content-management/cross-references.md @@ -116,7 +116,7 @@ produces this HTML: The behavior can, since Hugo 0.45, be configured in `config.toml`: -refLinksErrorLevel ("ERROR") +refLinksErrorLevel ("ERROR") : When using `ref` or `relref` to resolve page links and a link cannot resolved, it will be logged with this log level. Valid values are `ERROR` (default) or `WARNING`. Any `ERROR` will fail the build (`exit -1`). refLinksNotFoundURL diff --git a/content/en/content-management/diagrams.md b/content/en/content-management/diagrams.md index cc2a68cb4..5c247e569 100644 --- a/content/en/content-management/diagrams.md +++ b/content/en/content-management/diagrams.md @@ -45,14 +45,9 @@ Will be rendered as: 1 2 3 4 1 2 3 4 1 2 3 4 '--- 4 '-- 4 \ 4 ``` - - - - ## Mermaid Diagrams -Hugo currently does not provide default templates for Mermaid diagrams. But you can easily add your own. One way to do it would be to create ` layouts/_default/_markup/render-codeblock-mermaid.html`: - +Hugo currently does not provide default templates for Mermaid diagrams. But you can easily add your own. One way to do it would be to create `layouts/_default/_markup/render-codeblock-mermaid.html`: ```go-html-template
@@ -88,8 +83,6 @@ sequenceDiagram Bob-->>John: Jolly good! ``` - - ## Goat Ascii Diagram Examples ### Graphics @@ -160,7 +153,7 @@ sequenceDiagram ### File tree -Created from https://arthursonzogni.com/Diagon/#Tree +Created from ```goat { width=300 color="orange" } ───Linux─┬─Android @@ -176,7 +169,7 @@ Created from https://arthursonzogni.com/Diagon/#Tree ### Sequence Diagram -https://arthursonzogni.com/Diagon/#Sequence + ```goat { class="w-40" } ┌─────┐ ┌───┐ @@ -197,7 +190,7 @@ https://arthursonzogni.com/Diagon/#Sequence ### Flowchart -https://arthursonzogni.com/Diagon/#Flowchart + ```goat _________________ @@ -243,7 +236,7 @@ https://arthursonzogni.com/Diagon/#Flowchart ### Table -https://arthursonzogni.com/Diagon/#Table + ```goat { class="w-80 dark-blue" } ┌────────────────────────────────────────────────┐ diff --git a/content/en/content-management/formats.md b/content/en/content-management/formats.md index 303bb4596..89c209a61 100644 --- a/content/en/content-management/formats.md +++ b/content/en/content-management/formats.md @@ -55,13 +55,13 @@ Because additional formats are external commands, generation performance will re ### External Helper AsciiDoc -[AsciiDoc](https://github.com/asciidoc/asciidoc) implementation EOLs in Jan 2020 and is no longer supported. -AsciiDoc development is being continued under [Asciidoctor](https://github.com/asciidoctor). The format AsciiDoc +[AsciiDoc](https://github.com/asciidoc/asciidoc) implementation EOLs in Jan 2020 and is no longer supported. +AsciiDoc development is being continued under [Asciidoctor](https://github.com/asciidoctor). The format AsciiDoc remains of course. Please continue with the implementation Asciidoctor. ### External Helper Asciidoctor -The Asciidoctor community offers a wide set of tools for the AsciiDoc format that can be installed additionally to Hugo. +The Asciidoctor community offers a wide set of tools for the AsciiDoc format that can be installed additionally to Hugo. [See the Asciidoctor docs for installation instructions](https://asciidoctor.org/docs/install-toolchain/). Make sure that also all optional extensions like `asciidoctor-diagram` or `asciidoctor-html5s` are installed if required. @@ -109,7 +109,7 @@ Example of how to set extensions and attributes: my-attribute-name = "my value" ``` -In a complex Asciidoctor environment it is sometimes helpful to debug the exact call to your external helper with all +In a complex Asciidoctor environment it is sometimes helpful to debug the exact call to your external helper with all parameters. Run Hugo with `-v`. You will get an output like ``` diff --git a/content/en/content-management/front-matter.md b/content/en/content-management/front-matter.md index 20862074a..c4246d1d0 100644 --- a/content/en/content-management/front-matter.md +++ b/content/en/content-management/front-matter.md @@ -137,7 +137,7 @@ weight : used for [ordering your content in lists][ordering]. Lower weight gets higher precedence. So content with lower weight will come first. If set, weights should be non-zero, as 0 is interpreted as an *unset* 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._ +: 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" %}} 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. @@ -192,7 +192,7 @@ lang environment : A Glob pattern matching the build environment, e.g. "{production,development}" -Any of the above can be omitted. +Any of the above can be omitted. ### Example @@ -206,11 +206,9 @@ cascade: With the above example the Blog section page and its descendants will return `images/typewriter.jpg` when `.Params.banner` is invoked unless: -- Said descendant has its own `banner` value set +- Said descendant has its own `banner` value set - Or a closer ancestor node has its own `cascade.banner` value set. - - ## Order Content Through Front Matter You can assign content-specific `weight` in the front matter of your content. These values are especially useful for [ordering][ordering] in list views. You can use `weight` for ordering of content and the convention of [`_weight`][taxweight] for ordering content within a taxonomy. See [Ordering and Grouping Hugo Lists][lists] to see how `weight` can be used to organize your content in list views. @@ -221,9 +219,9 @@ It's possible to set some options for Markdown rendering in a content's front ma ## Front Matter Format Specs -* [TOML Spec][toml] -* [YAML Spec][yaml] -* [JSON Spec][json] +- [TOML Spec][toml] +- [YAML Spec][yaml] +- [JSON Spec][json] [variables]: /variables/ [aliases]: /content-management/urls/#aliases diff --git a/content/en/content-management/multilingual.md b/content/en/content-management/multilingual.md index abab72a60..b401cc924 100644 --- a/content/en/content-management/multilingual.md +++ b/content/en/content-management/multilingual.md @@ -507,6 +507,7 @@ The rendering of the main navigation works as usual. `.Site.Menus` will just con ``` ### Dynamically localizing menus with i18n + While customizing menus per language is useful, your config file can become hard to maintain if you have a lot of languages If your menus are the same in all languages (ie. if the only thing that changes is the translated name) you can use the `.Identifier` as a translation key for the menu name: @@ -569,10 +570,9 @@ If there is more than one language defined, the `LanguagePrefix` variable will e ## Generate multilingual content with `hugo new` + Currently, `hugo new` is not ready to support generating multilingual content. But there is a [proposal topic](https://github.com/gohugoio/hugo/issues/7732) about this in GitHub issue to discuss how it should work. - - [abslangurl]: /functions/abslangurl [config]: /getting-started/configuration/ [contenttemplate]: /templates/single-page-templates/ diff --git a/content/en/content-management/page-bundles.md b/content/en/content-management/page-bundles.md index 924efccd2..bb5516729 100644 --- a/content/en/content-management/page-bundles.md +++ b/content/en/content-management/page-bundles.md @@ -72,13 +72,13 @@ bundles: : This leaf bundle has the `index.md`, two other content Markdown files and two image files. -- image1, image2: +- image1, image2: These images are page resources of `my-post` and only available in `my-post/index.md` resources. -- content1, content2: +- content1, content2: These content files are page resources of `my-post` - and only available in `my-post/index.md` resources. + and only available in `my-post/index.md` resources. They will **not** be rendered as individual pages. `my-other-post` @@ -99,8 +99,8 @@ as long as it is not inside another **leaf** bundle. A headless bundle is a bundle that is configured to not get published anywhere: -- It will have no `Permalink` and no rendered HTML in `public/`. -- It will not be part of `.Site.RegularPages`, etc. +- It will have no `Permalink` and no rendered HTML in `public/`. +- It will not be part of `.Site.RegularPages`, etc. But you can get it by `.Site.GetPage`. Here is an example: @@ -121,9 +121,9 @@ _In this example, we are assuming the `some-headless-bundle` to be a headless Explanation of the above example: 1. Get the `some-headless-bundle` Page "object". -2. Collect a *slice* of resources in this *Page Bundle* that matches +2. Collect a _slice_ of resources in this _Page Bundle_ that matches `"author*"` using `.Resources.Match`. -3. Loop through that *slice* of nested pages, and output their `.Title` and +3. Loop through that _slice_ of nested pages, and output their `.Title` and `.Content`. --- @@ -137,9 +137,8 @@ headless = true There are many use cases of such headless page bundles: -- Shared media galleries -- Reusable page content "snippets" - +- Shared media galleries +- Reusable page content "snippets" ## Branch Bundles {#branch-bundles} diff --git a/content/en/content-management/page-resources.md b/content/en/content-management/page-resources.md index 24b1d03ed..c694fc409 100644 --- a/content/en/content-management/page-resources.md +++ b/content/en/content-management/page-resources.md @@ -90,6 +90,7 @@ MediaType.Suffixes : A slice of possible suffixes for the resource's MIME type. ## Methods + ByType : Returns the page resources of the given type. @@ -107,6 +108,7 @@ GetMatch : Same as `Match` but will return the first match. ### Pattern Matching + ```go // Using Match/GetMatch to find this images/sunset.jpg ? .Resources.Match "images/sun*" ✅ @@ -140,8 +142,7 @@ title params : A map of custom key/values. - -### Resources metadata example +### Resources metadata example {{< code-toggle copy="false">}} title: Application diff --git a/content/en/content-management/related.md b/content/en/content-management/related.md index c7262b42d..10dc50336 100644 --- a/content/en/content-management/related.md +++ b/content/en/content-management/related.md @@ -25,9 +25,9 @@ To list up to 5 related pages (which share the same _date_ or _keyword_ paramete {{ with $related }}

See Also

{{ end }} {{< /code >}} @@ -37,6 +37,7 @@ To list up to 5 related pages (which share the same _date_ or _keyword_ paramete Here is the list of "Related" methods available on a page collection such `.RegularPages`. #### .Related PAGE + Returns a collection of pages related the given one. ``` @@ -44,6 +45,7 @@ Returns a collection of pages related the given one. ``` #### .RelatedIndices PAGE INDICE1 [INDICE2 ...] + Returns a collection of pages related to a given one restricted to a list of indices. ``` @@ -51,6 +53,7 @@ Returns a collection of pages related to a given one restricted to a list of ind ``` #### .RelatedTo KEYVALS [KEYVALS2 ...] + Returns a collection of pages related together by a set of indices and their match. In order to build those set and pass them as argument, one must use the `keyVals` function where the first argument would be the `indice` and the consecutive ones its potential `matches`. @@ -64,6 +67,7 @@ Read [this blog article](https://regisphilibert.com/blog/2018/04/hugo-optmized-r {{% /note %}} ## Configure Related Content + Hugo provides a sensible default configuration of Related Content, but you can fine-tune this in your configuration, on the global or language level if needed. ### Default configuration diff --git a/content/en/content-management/shortcodes.md b/content/en/content-management/shortcodes.md index c5a126ab1..b2862f701 100644 --- a/content/en/content-management/shortcodes.md +++ b/content/en/content-management/shortcodes.md @@ -71,10 +71,9 @@ If you want the old behavior, you can put the following line in the start of you {{ $_hugo_config := `{ "version": 1 }` }} ``` - ### Shortcodes Without Markdown -The `<` character indicates that the shortcode's inner content does *not* need further rendering. Often shortcodes without markdown include internal HTML: +The `<` character indicates that the shortcode's inner content does *not* need further rendering. Often shortcodes without Markdown include internal HTML: ``` {{}}

Hello World!

{{}} @@ -86,11 +85,11 @@ You can call shortcodes within other shortcodes by creating your own templates t ## Use Hugo's Built-in Shortcodes -Hugo ships with a set of predefined shortcodes that represent very common usage. These shortcodes are provided for author convenience and to keep your markdown content clean. +Hugo ships with a set of predefined shortcodes that represent very common usage. These shortcodes are provided for author convenience and to keep your Markdown content clean. ### `figure` -`figure` is an extension of the image syntax in markdown, which does not provide a shorthand for the more semantic [HTML5 `
` element][figureelement]. +`figure` is an extension of the image syntax in Markdown, which does not provide a shorthand for the more semantic [HTML5 `
` element][figureelement]. The `figure` shortcode can use the following named parameters: @@ -254,7 +253,6 @@ Using the preceding `instagram` with `hidecaption` example above, the following {{< instagram BWNjjyYFxVx hidecaption >}} - {{% note %}} The `instagram`-shortcode refers an endpoint of Instagram's API, that's deprecated since October 24th, 2020. Thus, no images can be fetched from this API endpoint, resulting in an error when the `instagram`-shortcode is used. For more information please have a look at GitHub issue [#7879](https://github.com/gohugoio/hugo/issues/7879). {{% /note %}} @@ -360,7 +358,7 @@ Using the preceding `vimeo` example, the following HTML will be added to your re {{< /output >}} {{% tip %}} -If you want to further customize the visual styling of the YouTube or Vimeo output, add a `class` named parameter when calling the shortcode. The new `class` will be added to the `
` that wraps the `