nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-23 07:47:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

theme: docs wording

Browse source
This commit is contained in:
Sören Weber 2022-07-02 14:01:24 +02:00
parent 341bad1610
commit b1547e945f
No known key found for this signature in database
GPG key ID: 07D17FF580AE7589
3 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
exampleSite/config.toml
View file

@ -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 genertor 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\" }"
@ -47,7 +47,7 @@ title = "Hugo Relearn Documentation"
[outputs]
# add JSON to the home to support lunr search; This is a mandatory setting
# for the search functionality
# add PRINT to home, section and page to activate feature to print whole
# add PRINT to home, section and page to activate the feature to print whole
# chapters
home = ["HTML", "RSS", "PRINT", "JSON"]
section = ["HTML", "RSS", "PRINT"]
@ -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 code fences will not work anymore! So this is a mandatory
# setting for your site
# 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
@ -125,7 +125,7 @@ title = "Hugo Relearn Documentation"
# doing autotrrranlat'n of th' english content; we are
# lazy and don't supporrt furrrther trrranslations; arrr,
# don't take it t' serrrious, fello'; it's prrretty hacky and:
# NOT MEANT FOR PRRRODUCTION! ARRR!
# NOT MEANT FER PRRRODUCTION! ARRR!
[Languages.pir]
title = "Cap'n Hugo Relearrrn Theme"

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

@ -3,7 +3,7 @@ description = "Generate diagrams and flowcharts from text"
title = "Mermaid"
+++
With the [Mermaid](https://mermaidjs.github.io/) library and shortcode, you can generate diagrams and flowcharts from text, in a similar manner as Markdown.
The `mermaid` shortcode generates diagrams and flowcharts from text, in a similar manner as Markdown using the [Mermaid](https://mermaidjs.github.io/) library.
{{< mermaid >}}
graph LR;
@ -32,7 +32,7 @@ To use codefence syntax you have to turn off `guessSyntax` for the `markup.highl
{{< tabs groupId="shortcode-parameter">}}
{{% tab name="codefence" %}}
````plaintext
````md
```mermaid
graph LR;
If --> Then
@ -69,7 +69,7 @@ The generated graphs can be be panned by dragging them and zoomed by using the m
### Parameter
Parameter are only supported when using shortcode syntax. Defaults are used when using codefence syntax.
Parameter are only supported when using shortcode or partial syntax. Defaults are used when using codefence syntax.
| Name | Default | Notes |
|:----------------------|:-----------------|:------------|
@ -98,9 +98,9 @@ To use codefence syntax you have to turn off `guessSyntax` for the `markup.highl
[markup]
[markup.highlight]
# if set to `guessSyntax = true`, there will be no unstyled code even if no language
# was given BUT mermaid code fences will not work anymore! So this is a mandatory
# setting for your site
# 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
guessSyntax = false
````

2
static/js/theme.js
View file

@ -77,7 +77,7 @@ function restoreTabSelections() {
function initMermaid( update ) {
// we are either in update or initialization mode;
// during initialization, we want to edit the DOM;
// during update we only want to execute if something chanegd
// during update we only want to execute if something changed
var decodeHTML = function( html ){
var txt = document.createElement( 'textarea' );
txt.innerHTML = html;