diff --git a/exampleSite/config/_default/params.toml b/exampleSite/config/_default/params.toml index 38409a0184..fee6ae2d73 100644 --- a/exampleSite/config/_default/params.toml +++ b/exampleSite/config/_default/params.toml @@ -391,7 +391,7 @@ mathJaxInitialize = "{}" # If a Math shortcode is found, the option will be ignored and # MathJax will be loaded regardlessly. The option is still useful in case you # are using scripting to set up your graph. In this case no shortcode or -# codefence is involved and the library is not loaded by default. In this case +# Markdown codefence is involved and the library is not loaded by default. In this case # you can set `disableMathJax=false` in your frontmatter to force the library to # be loaded. # This can be overridden in the page's frontmatter. @@ -424,10 +424,10 @@ mermaidInitialize = "{ \"securityLevel\": \"loose\" }" # Only load Mermaid if needed. # Default: true -# If a Mermaid shortcode or codefence is found, the option will be ignored and +# If a Mermaid shortcode or Markdown codefence is found, the option will be ignored and # Mermaid will be loaded regardlessly. The option is still useful in case you # are using scripting to set up your graph. In this case no shortcode or -# codefence is involved and the library is not loaded by default. In this case +# Markdown codefence is involved and the library is not loaded by default. In this case # you can set `disableMermaid=false` in your frontmatter to force the library to # be loaded. # This can be overridden in the page's frontmatter. @@ -459,7 +459,7 @@ disableBlockquoteNoticeSupport = false # If a OpenAPI shortcode is found, the option will be ignored and # OpenAPI will be loaded regardlessly. The option is still useful in case you # are using scripting to set up your graph. In this case no shortcode or -# codefence is involved and the library is not loaded by default. In this case +# Markdown codefence is involved and the library is not loaded by default. In this case # you can set `disableOpenapi=false` in your frontmatter to force the library to # be loaded. # This can be overridden in the page's frontmatter. diff --git a/exampleSite/content/basics/migration/_index.en.md b/exampleSite/content/basics/migration/_index.en.md index 99c841e577..eacb563c42 100644 --- a/exampleSite/content/basics/migration/_index.en.md +++ b/exampleSite/content/basics/migration/_index.en.md @@ -95,7 +95,7 @@ This document shows you what's new in the latest release and flags it with one o - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The [`include` shortcode](shortcodes/include) is now able to resolve links to resources as well as to files in the file system (the old behavior). You can configure to generate warnings or errors during build by setting `include.errorlevel` to either `warning` or `error` in your `hugo.toml` if a path can not be resolved. -- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Math is now usable without enclosing it in a shortcode or codefence by using Hugo's [passthrough configuration](shortcodes/math#passthrough-configuration). +- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Math is now usable without enclosing it in a shortcode or Markdown codefence by using Hugo's [passthrough configuration](shortcodes/math#passthrough-configuration). - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Translation into Romanian. @@ -129,7 +129,7 @@ This document shows you what's new in the latest release and flags it with one o - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} It is now possible to [adjust the max width of the main area](basics/customization#change-the-main-areas-max-width), eg. in case you want to use the full page width for your content. -- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Images and Codefences are now respecting [Hugo's Markdown attributes](https://gohugo.io/content-management/markdown-attributes/). +- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Images and Markdown codefences are now respecting [Hugo's Markdown attributes](https://gohugo.io/content-management/markdown-attributes/). - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The theme has updated its Mermaid dependency to 10.6.0. This adds support for [block diagrams](shortcodes/mermaid#block-diagram). @@ -313,7 +313,7 @@ This document shows you what's new in the latest release and flags it with one o ## 5.19.0 (2023-08-12) {#5190} -- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The [`highlight` shortcode](shortcodes/highlight) now accepts the new parameter `title`. This displays the code like a [single tab](shortcodes/tab). This is also available using codefences and makes it much easier to write nicer code samples. +- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The [`highlight` shortcode](shortcodes/highlight) now accepts the new parameter `title`. This displays the code like a [single tab](shortcodes/tab). This is also available using Markdown codefences and makes it much easier to write nicer code samples. - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The theme has added two new color variants `zen-light` and `zen-dark`. Check it out! @@ -602,7 +602,7 @@ This document shows you what's new in the latest release and flags it with one o - {{% badge style="note" title=" " %}}Change{{% /badge %}} The [`button` shortcode](shortcodes/button) has a new parameter `target` to set the destination frame/window for the URL to open. If not given, it defaults to a new window/tab for external URLs or is not set at all for internal URLs. Previously even internal URLs where opened in a new window/tab. -- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The [`math` shortcode](shortcodes/math) and [`mermaid` shortcode](shortcodes/mermaid) now also support the `align` parameter if codefence syntax is used. +- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The [`math` shortcode](shortcodes/math) and [`mermaid` shortcode](shortcodes/mermaid) now also support the `align` parameter if Markdown codefences are used. - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Support for languages that are written right to left (like Arabic). This is only implemented for the content area but not the navigation sidebar. This feature is not available in Internet Explorer 11. @@ -737,9 +737,9 @@ This document shows you what's new in the latest release and flags it with one o - {{% badge color="fuchsia" icon="fa-fw fab fa-hackerrank" title=" " %}}0.93.0{{% /badge %}} This release requires a newer Hugo version. -- {{% badge style="note" title=" " %}}Change{{% /badge %}} In this release the Mermaid JavaScript library will only be loaded on demand if the page contains a Mermaid shortcode or is using Mermaid codefences. This changes the behavior of `disableMermaid` config option as follows: If a Mermaid shortcode or codefence is found, the option will be ignored and Mermaid will be loaded regardlessly. +- {{% badge style="note" title=" " %}}Change{{% /badge %}} In this release the Mermaid JavaScript library will only be loaded on demand if the page contains a Mermaid shortcode or is using Markdown codefences. This changes the behavior of `disableMermaid` config option as follows: If a Mermaid shortcode or Markdown codefence is found, the option will be ignored and Mermaid will be loaded regardlessly. - The option is still useful in case you are using scripting to set up your graph. In this case no shortcode or codefence is involved and the library is not loaded by default. In this case you can set `disableMermaid=false` in your frontmatter to force the library to be loaded. See the [theme variant generator](basics/generator) of the exampleSite for an example. + The option is still useful in case you are using scripting to set up your graph. In this case no shortcode or Markdown codefence is involved and the library is not loaded by default. In this case you can set `disableMermaid=false` in your frontmatter to force the library to be loaded. See the [theme variant generator](basics/generator) of the exampleSite for an example. - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Additional color variant variable `--MERMAID-theme` to set the variant's Mermaid theme. This causes the Mermaid theme to switch with the color variant if it defers from the setting of the formerly selected color variant. diff --git a/exampleSite/content/cont/frontmatter/frontmatter.toml b/exampleSite/content/cont/frontmatter/frontmatter.toml index 5ddfd726e2..2a564796b7 100644 --- a/exampleSite/content/cont/frontmatter/frontmatter.toml +++ b/exampleSite/content/cont/frontmatter/frontmatter.toml @@ -231,7 +231,7 @@ mathJaxInitialize = "{}" # If a Math shortcode is found, the option will be ignored and # MathJax will be loaded regardlessly. The option is still useful in case you # are using scripting to set up your graph. In this case no shortcode or -# codefence is involved and the library is not loaded by default. In this case +# Markdown codefence is involved and the library is not loaded by default. In this case # you can set `disableMathJax=false` in your frontmatter to force the library to # be loaded. # If not set, the set value of your site's hugo.toml is used. @@ -264,10 +264,10 @@ mermaidInitialize = "{ \"securityLevel\": \"loose\" }" # Only load Mermaid if needed. # Default: true -# If a Mermaid shortcode or codefence is found, the option will be ignored and +# If a Mermaid shortcode or Markdown codefence is found, the option will be ignored and # Mermaid will be loaded regardlessly. The option is still useful in case you # are using scripting to set up your graph. In this case no shortcode or -# codefence is involved and the library is not loaded by default. In this case +# Markdown codefence is involved and the library is not loaded by default. In this case # you can set `disableMermaid=false` in your frontmatter to force the library to # be loaded. # If not set, the set value of your site's hugo.toml is used. @@ -289,7 +289,7 @@ customMermaidURL = "" # "https://unpkg.com/mermaid/dist/mermaid.min.js" # If a OpenAPI shortcode is found, the option will be ignored and # OpenAPI will be loaded regardlessly. The option is still useful in case you # are using scripting to set up your graph. In this case no shortcode or -# codefence is involved and the library is not loaded by default. In this case +# Markdown codefence is involved and the library is not loaded by default. In this case # you can set `disableOpenapi=false` in your frontmatter to force the library to # be loaded. # If not set, the set value of your site's hugo.toml is used. diff --git a/exampleSite/content/shortcodes/highlight.en.md b/exampleSite/content/shortcodes/highlight.en.md index 5c4024cd9f..214defb10e 100644 --- a/exampleSite/content/shortcodes/highlight.en.md +++ b/exampleSite/content/shortcodes/highlight.en.md @@ -13,14 +13,14 @@ print("Hello World!") This shortcode is fully compatible with Hugo's [`highlight` shortcode](https://gohugo.io/content-management/syntax-highlighting/#highlight-shortcode) but **offers some extensions**. -It is called interchangeably in the same way as Hugo's own shortcode providing positional parameter or by simply using codefences. +It is called interchangeably in the same way as Hugo's own shortcode providing positional parameter or by simply using Markdown codefences. You are free to also call this shortcode from your own partials. In this case it resembles Hugo's [`highlight` function](https://gohugo.io/functions/highlight/) syntax if you call this shortcode as a partial using compatibility syntax. -While the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports codefences (eg. GitHub) and so your markdown becomes more portable. +While the examples are using shortcodes with named parameter it is recommended to use Markdown codefences instead. This is because more and more other software supports Markdown codefences (eg. GitHub) and so your Markdown becomes more portable. {{< tabs groupid="shortcode-parameter">}} -{{% tab title="codefence" %}} +{{% tab title="markdown" %}} ````md ```py { lineNos="true" wrap="true" title="python" } @@ -142,7 +142,7 @@ print("World") print("!") {{< /highlight >}} -### Codefence with Title +### Markdown Codefence with Title ````md diff --git a/exampleSite/content/shortcodes/math.en.md b/exampleSite/content/shortcodes/math.en.md index 7e12de73b2..5b80815bdc 100644 --- a/exampleSite/content/shortcodes/math.en.md +++ b/exampleSite/content/shortcodes/math.en.md @@ -11,14 +11,14 @@ $$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \ ## Usage -While the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports Math codefences (eg. GitHub) and so your markdown becomes more portable. +While the examples are using shortcodes with named parameter it is recommended to use Markdown codefences instead. This is because more and more other software supports Markdown codefences (eg. GitHub) and so your markdown becomes more portable. You are free to also call this shortcode from your own partials. -Math is also usable without enclosing it in a shortcode or codefence but [requires configuration](#passthrough-configuration) by you. In this case no parameter from the below table are available. +Math is also usable without enclosing it in a shortcode or Markdown codefence but [requires configuration](#passthrough-configuration) by you. In this case no parameter from the below table are available. {{< tabs groupid="shortcode-parameter">}} -{{% tab title="codefence" %}} +{{% tab title="markdown" %}} ````md ```math { align="center" } @@ -92,7 +92,7 @@ mathJaxInitialize = "{ \"chtml\": { \"displayAlign\": \"left\" }, { \"tex\": { \ ### Passthrough Configuration -You can use your math without enclosing it in a shortcode or codefence by using a [passthrough configuration](https://gohugo.io/content-management/mathematics/#step-1) in your `hugo.toml`: +You can use your math without enclosing it in a shortcode or Markdown codefence by using a [passthrough configuration](https://gohugo.io/content-management/mathematics/#step-1) in your `hugo.toml`: {{< multiconfig file=hugo >}} [markup] @@ -139,9 +139,9 @@ If you delimit your formulae by two consecutive `$$` it generates a new block. $$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$ {{< /math >}} -### Codefence +### Markdown Codefence -You can also use codefences. +You can also use Markdown codefences. ````md ```math @@ -157,7 +157,7 @@ $$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \ This works for block as well as inline math but is only available if you are using the [passthrough configuration](#passthrough-configuration). -With passthrough configuration you can just drop your math without enclosed by shortcodes or codefences but no settings from the [parameter table](#parameter) are available. +With passthrough configuration you can just drop your math without enclosed by shortcodes or Markdown codefences but no settings from the [parameter table](#parameter) are available. ````md $$\left| diff --git a/exampleSite/content/shortcodes/mermaid.en.md b/exampleSite/content/shortcodes/mermaid.en.md index a189d9fffa..1f911a11a7 100644 --- a/exampleSite/content/shortcodes/mermaid.en.md +++ b/exampleSite/content/shortcodes/mermaid.en.md @@ -13,12 +13,12 @@ graph LR; ## Usage -While the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports Mermaid codefences (eg. GitHub) and so your markdown becomes more portable. +While the examples are using shortcodes with named parameter it is recommended to use Markdown codefences instead. This is because more and more other software supports Mermaid Markdown codefences (eg. GitHub) and so your markdown becomes more portable. You are free to also call this shortcode from your own partials. {{< tabs groupid="shortcode-parameter">}} -{{% tab title="codefence" %}} +{{% tab title="markdown" %}} ````md ```mermaid { align="center" zoom="true" } @@ -148,7 +148,7 @@ sequenceDiagram Bob-->>John: Jolly good! {{< /mermaid >}} -### Class Diagram with Codefence Syntax +### Class Diagram with Markdown Codefence Syntax ````go ```mermaid