nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-27 09:43:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: removed some typos

Browse source
This commit is contained in:
Sören Weber 2022-10-03 12:02:22 +02:00
parent b429be3ee1
commit 5170353967
No known key found for this signature in database
GPG key ID: BEC6D55545451B6D
3 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
exampleSite/config.toml
View file

@ -38,7 +38,7 @@ title = "Hugo Relearn Documentation"
titleSeparator = "::" titleSeparator = "::"
themeVariant = [ "relearn-light", "relearn-dark", "learn", "neon", "blue", "green", "red" ] themeVariant = [ "relearn-light", "relearn-dark", "learn", "neon", "blue", "green", "red" ]
disableSeoHiddenPages = true 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 # graphs; you usually will not need it and you should remove this for
# security reasons # security reasons
mermaidInitialize = "{ \"securityLevel\": \"loose\" }" mermaidInitialize = "{ \"securityLevel\": \"loose\" }"
@ -56,8 +56,8 @@ title = "Hugo Relearn Documentation"
[markup] [markup]
[markup.highlight] [markup.highlight]
# if `guessSyntax = true`, there will be no unstyled code even if no language # 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 # 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 # mandatory setting for your site if you want to use Mermaid or Math codefences
guessSyntax = false guessSyntax = false
# here in this showcase we use our own modified chroma syntax highlightning style # here in this showcase we use our own modified chroma syntax highlightning style

6
exampleSite/content/shortcodes/math.en.md
View file

@ -15,7 +15,7 @@ This only works in modern browsers.
## Usage ## 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. 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]
[markup.highlight] [markup.highlight]
# if `guessSyntax = true`, there will be no unstyled code even if no language # 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 # 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 # mandatory setting for your site if you want to use Math codefences
guessSyntax = false guessSyntax = false
```` ````

6
exampleSite/content/shortcodes/mermaid.en.md
View file

@ -74,7 +74,7 @@ Parameter are only supported when using shortcode or partial syntax. Defaults ar
| Name | Default | Notes | | Name | Default | Notes |
|:----------------------|:-----------------|:------------| |:----------------------|:-----------------|:------------|
| **align** | `center` | Allowed values are `left`, `center` or `right`. | | **align** | `center` | Allowed values are `left`, `center` or `right`. |
| _**<content>**_ | _<empty>_ | Your mermaid graph. | | _**<content>**_ | _<empty>_ | Your Mermaid graph. |
## Configuration ## Configuration
@ -99,8 +99,8 @@ To use codefence syntax you have to turn off `guessSyntax` for the `markup.highl
[markup] [markup]
[markup.highlight] [markup.highlight]
# if `guessSyntax = true`, there will be no unstyled code even if no language # 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 # 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 # mandatory setting for your site if you want to use Mermaid codefences
guessSyntax = false guessSyntax = false
```` ````