From 5170353967cf89bb2bdfbf69920a268a81300439 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Weber?= Date: Mon, 3 Oct 2022 12:02:22 +0200 Subject: [PATCH] docs: removed some typos --- exampleSite/config.toml | 6 +++--- exampleSite/content/shortcodes/math.en.md | 6 +++--- exampleSite/content/shortcodes/mermaid.en.md | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/exampleSite/config.toml b/exampleSite/config.toml index 4a96902917..2fcc478c81 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -38,7 +38,7 @@ title = "Hugo Relearn Documentation" titleSeparator = "::" themeVariant = [ "relearn-light", "relearn-dark", "learn", "neon", "blue", "green", "red" ] disableSeoHiddenPages = true - # this is for the stylesheet generator to allow for interactivity in mermaid + # this is for the stylesheet generator to allow for interactivity in Mermaid # graphs; you usually will not need it and you should remove this for # security reasons mermaidInitialize = "{ \"securityLevel\": \"loose\" }" @@ -56,8 +56,8 @@ title = "Hugo Relearn Documentation" [markup] [markup.highlight] # if `guessSyntax = true`, there will be no unstyled code even if no language - # was given BUT mermaid and math codefences will not work anymore! So this is a - # mandatory setting for your site if you want to use mermaid or math codefences + # was given BUT Mermaid and Math codefences will not work anymore! So this is a + # mandatory setting for your site if you want to use Mermaid or Math codefences guessSyntax = false # here in this showcase we use our own modified chroma syntax highlightning style diff --git a/exampleSite/content/shortcodes/math.en.md b/exampleSite/content/shortcodes/math.en.md index 19f126952a..2ed9eceeca 100644 --- a/exampleSite/content/shortcodes/math.en.md +++ b/exampleSite/content/shortcodes/math.en.md @@ -15,7 +15,7 @@ This only works in modern browsers. ## 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 codefences instead. This is because more and more other software supports Math codefences (eg. GitHub) and so your markdown becomes more portable. You are free to also call this shortcode from your own partials. @@ -85,8 +85,8 @@ To use codefence syntax you have to turn off `guessSyntax` for the `markup.highl [markup] [markup.highlight] # if `guessSyntax = true`, there will be no unstyled code even if no language - # was given BUT mermaid and math codefences will not work anymore! So this is a - # mandatory setting for your site if you want to use math codefences + # was given BUT Mermaid and Math codefences will not work anymore! So this is a + # mandatory setting for your site if you want to use Math codefences guessSyntax = false ```` diff --git a/exampleSite/content/shortcodes/mermaid.en.md b/exampleSite/content/shortcodes/mermaid.en.md index 485ddb3272..8944840bc3 100644 --- a/exampleSite/content/shortcodes/mermaid.en.md +++ b/exampleSite/content/shortcodes/mermaid.en.md @@ -74,7 +74,7 @@ Parameter are only supported when using shortcode or partial syntax. Defaults ar | Name | Default | Notes | |:----------------------|:-----------------|:------------| | **align** | `center` | Allowed values are `left`, `center` or `right`. | -| _**<content>**_ | _<empty>_ | Your mermaid graph. | +| _**<content>**_ | _<empty>_ | Your Mermaid graph. | ## Configuration @@ -99,8 +99,8 @@ To use codefence syntax you have to turn off `guessSyntax` for the `markup.highl [markup] [markup.highlight] # if `guessSyntax = true`, there will be no unstyled code even if no language - # was given BUT mermaid and math codefences will not work anymore! So this is a - # mandatory setting for your site if you want to use mermaid codefences + # was given BUT Mermaid and Math codefences will not work anymore! So this is a + # mandatory setting for your site if you want to use Mermaid codefences guessSyntax = false ````