diff --git a/404.html b/404.html index 0ff8486af5..5971b7e6df 100644 --- a/404.html +++ b/404.html @@ -5,16 +5,16 @@ - + 404 Page not found :: Documentation for Hugo Relearn Theme - - - - - - - - + + + + + + + + diff --git a/basics/changelog/index.html b/basics/changelog/index.html index cf2e1f0b2b..6e1901ea84 100644 --- a/basics/changelog/index.html +++ b/basics/changelog/index.html @@ -6,18 +6,18 @@ - + :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn - - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
- - + + - +
+

Notice wit' Custom Title

+

Ye can cust'mize th' title o' th' notice by pass'n it as a second parameter.

+
+
Pay Attent'n t' this Avast!

Th' title be now th' parameter that was provided.

+
+
+ + + +Show marrrkup + + +
@@ -341,14 +361,14 @@ Ye can add:
- - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/siteparam/index.html b/pir/shortcodes/siteparam/index.html index 7c23124f63..4310fa25d8 100644 --- a/pir/shortcodes/siteparam/index.html +++ b/pir/shortcodes/siteparam/index.html @@ -5,18 +5,18 @@ - + Ship param :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -32,10 +32,10 @@ Relearn - - + + - +

Ship param

-

siteparam shorrrtcode be used t' help ye print values o' ship params.

+

Th' siteparam shorrrtcode be used t' help ye print values o' ship params.

+

Usage

+
{{% siteparam <str'n %}}
+

Th' first required parameter be th' name o' th' ship param t' be displayed.

+

Examples

For instance, 'n this current ship, th' editURL vari'ble be used 'n config.toml

[params]
   editURL = "https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/"
@@ -163,14 +167,14 @@ Relearn
 

 

 

-
-
-
-
-
-
-
+
+
+
+
+
+
+
 
-
+
 
 
\ No newline at end of file
diff --git a/pir/shortcodes/tabs/index.html b/pir/shortcodes/tabs/index.html
index 4243a86f8a..a44882d8d5 100644
--- a/pir/shortcodes/tabs/index.html
+++ b/pir/shortcodes/tabs/index.html
@@ -5,18 +5,18 @@
 
 
 
-
+
 Tabbed views :: Documentat'n fer Cap'n Hugo Relearrrn Theme
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
 
 
 
@@ -32,10 +32,10 @@ Relearn
- - + + - +
    @@ -269,14 +269,14 @@ from th' 'default' group on a different plank then all tabs will be
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/showcase/index.html b/pir/showcase/index.html index ee5a626217..af3c3465cf 100644 --- a/pir/showcase/index.html +++ b/pir/showcase/index.html @@ -5,18 +5,18 @@ - + Showcase :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -32,10 +32,10 @@ Relearn
- - + + - +
    @@ -153,14 +153,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/tags/children/index.html b/pir/tags/children/index.html index 3db246db49..e2c0df50b6 100644 --- a/pir/tags/children/index.html +++ b/pir/tags/children/index.html @@ -6,18 +6,18 @@ - + children :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -164,14 +164,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/tags/documentatn/index.html b/pir/tags/documentatn/index.html index c976a82052..be72590824 100644 --- a/pir/tags/documentatn/index.html +++ b/pir/tags/documentatn/index.html @@ -6,18 +6,18 @@ - + documentat'n :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -151,14 +151,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/tags/hidden/index.html b/pir/tags/hidden/index.html index 70289e44d6..252235f89c 100644 --- a/pir/tags/hidden/index.html +++ b/pir/tags/hidden/index.html @@ -6,18 +6,18 @@ - + hidden :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -155,14 +155,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/tags/index.html b/pir/tags/index.html index 992c68b697..9ae0e7d619 100644 --- a/pir/tags/index.html +++ b/pir/tags/index.html @@ -6,18 +6,18 @@ - + Tags :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -154,14 +154,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/tags/non-hidden/index.html b/pir/tags/non-hidden/index.html index 3de42955ef..fa6466e5c5 100644 --- a/pir/tags/non-hidden/index.html +++ b/pir/tags/non-hidden/index.html @@ -6,18 +6,18 @@ - + non-hidden :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -159,14 +159,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/tags/tutorrrial/index.html b/pir/tags/tutorrrial/index.html index 95b6809760..bf163d9bf4 100644 --- a/pir/tags/tutorrrial/index.html +++ b/pir/tags/tutorrrial/index.html @@ -6,18 +6,18 @@ - + tutorrrial :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -151,14 +151,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/yours/children-1/index.html b/pir/yours/children-1/index.html index a256334620..82ac88a85f 100644 --- a/pir/yours/children-1/index.html +++ b/pir/yours/children-1/index.html @@ -6,18 +6,18 @@ - + Th' one an' only hidden child :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -158,14 +158,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/yours/index.html b/pir/yours/index.html index c69d897694..ff41b30384 100644 --- a/pir/yours/index.html +++ b/pir/yours/index.html @@ -6,18 +6,18 @@ - + This could be yers :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -153,14 +153,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/attachments/index.html b/shortcodes/attachments/index.html index b640489a88..d0f3bfb48e 100644 --- a/shortcodes/attachments/index.html +++ b/shortcodes/attachments/index.html @@ -5,18 +5,18 @@ - + Attachments :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -32,10 +32,10 @@ Relearn
- - + + - +
    @@ -325,14 +325,14 @@ Currently, it support two implementations for pages

    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/button/index.html b/shortcodes/button/index.html index c5512d4c7d..8785073d47 100644 --- a/shortcodes/button/index.html +++ b/shortcodes/button/index.html @@ -5,18 +5,18 @@ - + Button :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -32,10 +32,10 @@ Relearn
- - + + - +
    @@ -172,14 +172,14 @@ Get Hugo with icon right
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html index bf0cacf101..898fd7dda2 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html @@ -6,18 +6,18 @@ - + page 1-1-1-1-1-1 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -171,14 +171,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html index 49a87c1dbc..2217fd0958 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html @@ -6,18 +6,18 @@ - + page 1-1-1-1-1 (hidden) :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -178,14 +178,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html index df631f1a79..2d49377517 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html @@ -6,18 +6,18 @@ - + page 1-1-1-1 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -175,14 +175,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html index a162af0a1b..85da8d0b13 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html @@ -6,18 +6,18 @@ - + page 1-1-1 (hidden) :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -174,14 +174,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html index bd61722d83..ad697e0d6b 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html @@ -6,18 +6,18 @@ - + page 1-1-2-1 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -165,14 +165,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html index 7a31272cc5..1c44bd57fb 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html @@ -6,18 +6,18 @@ - + page 1-1-2-2 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -165,14 +165,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-2/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-2/index.html index 807ee6c0bb..afdd2c5091 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-2/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-2/index.html @@ -6,18 +6,18 @@ - + page 1-1-2 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -173,14 +173,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html index d54c2b61b4..48a7ccf037 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html @@ -6,18 +6,18 @@ - + page 1-1-3 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -164,14 +164,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-1/children-1-1/index.html b/shortcodes/children/children-1/children-1-1/index.html index d549ccedd1..e3fd387aac 100644 --- a/shortcodes/children/children-1/children-1-1/index.html +++ b/shortcodes/children/children-1/children-1-1/index.html @@ -6,18 +6,18 @@ - + page 1-1 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -173,14 +173,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-1/index.html b/shortcodes/children/children-1/index.html index d643734821..92cfcb5a83 100644 --- a/shortcodes/children/children-1/index.html +++ b/shortcodes/children/children-1/index.html @@ -6,18 +6,18 @@ - + page 1 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -170,14 +170,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-2/index.html b/shortcodes/children/children-2/index.html index df05aabeab..cabbcfb67b 100644 --- a/shortcodes/children/children-2/index.html +++ b/shortcodes/children/children-2/index.html @@ -6,18 +6,18 @@ - + page 2 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -163,14 +163,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-3/index.html b/shortcodes/children/children-3/index.html index 7f2b9f661f..ca2696849e 100644 --- a/shortcodes/children/children-3/index.html +++ b/shortcodes/children/children-3/index.html @@ -6,18 +6,18 @@ - + page 3 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -170,14 +170,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-3/test3/index.html b/shortcodes/children/children-3/test3/index.html index 987ab3262b..b07fc01580 100644 --- a/shortcodes/children/children-3/test3/index.html +++ b/shortcodes/children/children-3/test3/index.html @@ -5,18 +5,18 @@ - + page 3-1 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -32,10 +32,10 @@ Relearn
- - + + - +
    @@ -162,14 +162,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-4/index.html b/shortcodes/children/children-4/index.html index f94598745c..c26342dae5 100644 --- a/shortcodes/children/children-4/index.html +++ b/shortcodes/children/children-4/index.html @@ -6,18 +6,18 @@ - + page 4 (hidden) :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -163,14 +163,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/index.html b/shortcodes/children/index.html index 5c8be34756..1a9f06f952 100644 --- a/shortcodes/children/index.html +++ b/shortcodes/children/index.html @@ -6,18 +6,18 @@ - + Children :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -287,14 +287,14 @@ So its content is used as description.

    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/test/index.html b/shortcodes/children/test/index.html index 048557c438..e5b88fa08a 100644 --- a/shortcodes/children/test/index.html +++ b/shortcodes/children/test/index.html @@ -6,18 +6,18 @@ - + page X :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -158,14 +158,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/expand/index.html b/shortcodes/expand/index.html index 6fc686710b..e432663b47 100644 --- a/shortcodes/expand/index.html +++ b/shortcodes/expand/index.html @@ -5,18 +5,18 @@ - + Expand :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -32,10 +32,10 @@ Relearn
- - + + - +
    @@ -156,7 +156,7 @@ Relearn

    Expand

    The Expand shortcode displays an expandable/collapsible section of text on your page.

    Usage

    -
    {{% expand "Does this Relearn theme rock?" { "true" | "false" } %}}
+
    {{% expand [ <string> [ "true" | "false" ] ] %}}
 Yes!
 {{% /expand %}}
 
    The first optional parameter defines the text that appears next to the expand/collapse icon. The default text is "Expand me...".
    
@@ -284,14 +284,14 @@ You can add:
 
    
 
    
 
    
-
-
-
-
-
-
-
+
+
+
+
+
+
+
 
-
+
 
 
\ No newline at end of file
diff --git a/shortcodes/include/index.html b/shortcodes/include/index.html
index e2d2ef503c..539fe24a0c 100644
--- a/shortcodes/include/index.html
+++ b/shortcodes/include/index.html
@@ -5,18 +5,18 @@
 
 
 
-
+
 Include :: Documentation for Hugo Relearn Theme
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
 
 
 
@@ -32,10 +32,10 @@ Relearn
    - - + + - +
    @@ -154,9 +154,9 @@ Relearn

    Include

    The include shortcode includes other files from your project inside of the current file. This can even contain Markdown and will be taken into account when generating the table of contents.

    Usage

    -
    {{% include "<file>" { "true" | "false" } %}}
-

    The first parameter is the path to the file to be included.

    -

    If the file’s content will be displayed as HTML, the second optional parameter controls if the first heading of the included file should be displayed (“true”)- which is the default - or be hidden.

    +
    {{% include <string> [ "true" | "false" ] %}}
+

    The first required parameter is the path to the file to be included.

    +

    If the file’s content will be displayed as HTML, the second optional parameter controls if the first heading of the included file should be displayed ("true")- which is the default - or be hidden.

    Examples

    Arbitray content

    You can add:

    @@ -195,14 +195,14 @@ Show markup
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/include_me/index.html b/shortcodes/include_me/index.html index d81e491735..af86ce2e9e 100644 --- a/shortcodes/include_me/index.html +++ b/shortcodes/include_me/index.html @@ -6,18 +6,18 @@ - + :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -170,14 +170,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/index.html b/shortcodes/index.html index a30bdcaf46..8e4fe292cd 100644 --- a/shortcodes/index.html +++ b/shortcodes/index.html @@ -6,18 +6,18 @@ - + Shortcodes :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -176,14 +176,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/index.xml b/shortcodes/index.xml index d058f82e92..cdd9e554c8 100644 --- a/shortcodes/index.xml +++ b/shortcodes/index.xml @@ -3,20 +3,20 @@ Usage Parameter Default Description page current Specify the page name (section Attachments adivorciarsetoca00cape.pdf (361 KB) BachGavotteShort.mp3 (357 KB) Carroll_AliceAuPaysDesMerveilles.pdf (175 KB) hugo.png (17 KB) hugo.txt (20 B) movieselectricsheep-flock-244-32500-2.mp4 (340 KB) Usage The shortcurt lists files found in a specific folder. Currently, it support two implementations for pages If your page is a Markdown file, attachements must be placed in a folder named like your page and ending with .Buttonhttps://McShelby.github.io/hugo-theme-relearn/shortcodes/button/Mon, 01 Jan 0001 00:00:00 +0000https://McShelby.github.io/hugo-theme-relearn/shortcodes/button/A button is a just a clickable button with optional icon. {{% button href=&#34;https://gohugo.io/&#34; %}}Get Hugo{{% /button %}} {{% button href=&#34;https://gohugo.io/&#34; icon=&#34;fas fa-download&#34; %}}Get Hugo with icon{{% /button %}} {{% button href=&#34;https://gohugo.io/&#34; icon=&#34;fas fa-download&#34; icon-position=&#34;right&#34; %}}Get Hugo with icon right{{% /button %}} Get Hugo Get Hugo with icon Get Hugo with icon rightExpandhttps://McShelby.github.io/hugo-theme-relearn/shortcodes/expand/Mon, 01 Jan 0001 00:00:00 +0000https://McShelby.github.io/hugo-theme-relearn/shortcodes/expand/The Expand shortcode displays an expandable/collapsible section of text on your page. -Usage {{% expand &#34;Does this Relearn theme rock?&#34; { &#34;true&#34; | &#34;false&#34; } %}} Yes! {{% /expand %}} The first optional parameter defines the text that appears next to the expand/collapse icon. The default text is &quot;Expand me...&quot;. -The second optional parameter controls if the block is initially shown as expanded (&quot;true&quot;) or collapsed (&quot;false&quot;). The default ist &quot;false&quot;.Includehttps://McShelby.github.io/hugo-theme-relearn/shortcodes/include/Mon, 01 Jan 0001 00:00:00 +0000https://McShelby.github.io/hugo-theme-relearn/shortcodes/include/The include shortcode includes other files from your project inside of the current file. This can even contain Markdown and will be taken into account when generating the table of contents. -Usage {{% include &#34;&lt;file&gt;&#34; { &#34;true&#34; | &#34;false&#34; } %}} The first parameter is the path to the file to be included. -If the file&rsquo;s content will be displayed as HTML, the second optional parameter controls if the first heading of the included file should be displayed (&ldquo;true&rdquo;)- which is the default - or be hidden.Mermaidhttps://McShelby.github.io/hugo-theme-relearn/shortcodes/mermaid/Mon, 01 Jan 0001 00:00:00 +0000https://McShelby.github.io/hugo-theme-relearn/shortcodes/mermaid/Mermaid is a library helping you to generate diagram and flowcharts from text, in a similar manner as Markdown. +Usage {{% expand [ &lt;string&gt; [ &#34;true&#34; | &#34;false&#34; ] ] %}} Yes! {{% /expand %}} The first optional parameter defines the text that appears next to the expand/collapse icon. The default text is &quot;Expand me...&quot;. +The second optional parameter controls if the block is initially shown as expanded (&quot;true&quot;) or collapsed (&quot;false&quot;). The default ist &quot;false&quot;. +Examples I&#39;ll tell you a secret.Includehttps://McShelby.github.io/hugo-theme-relearn/shortcodes/include/Mon, 01 Jan 0001 00:00:00 +0000https://McShelby.github.io/hugo-theme-relearn/shortcodes/include/The include shortcode includes other files from your project inside of the current file. This can even contain Markdown and will be taken into account when generating the table of contents. +Usage {{% include &lt;string&gt; [ &#34;true&#34; | &#34;false&#34; ] %}} The first required parameter is the path to the file to be included. +If the file&rsquo;s content will be displayed as HTML, the second optional parameter controls if the first heading of the included file should be displayed (&quot;true&quot;)- which is the default - or be hidden.Mermaidhttps://McShelby.github.io/hugo-theme-relearn/shortcodes/mermaid/Mon, 01 Jan 0001 00:00:00 +0000https://McShelby.github.io/hugo-theme-relearn/shortcodes/mermaid/Mermaid is a library helping you to generate diagram and flowcharts from text, in a similar manner as Markdown. Usage Just insert your Mermaid code in the mermaid shortcode like this: -{{&lt; mermaid [ align=(left|right|center|justify) ] &gt;}} classDiagram Person *-- Dog {{&lt; /mermaid &gt;}} You can set an optional align attribute which defaults to center. +{{&lt; mermaid [ align=(&#34;left&#34;|&#34;right&#34;|&#34;center&#34;|&#34;justify&#34;) ] &gt;}} classDiagram Person *-- Dog {{&lt; /mermaid &gt;}} You can set an optional align attribute which defaults to &quot;center&quot;. If you don&rsquo;t need alignment you can use the alternative syntax using code fences if you have turned off guessSyntax for the markup.Noticehttps://McShelby.github.io/hugo-theme-relearn/shortcodes/notice/Mon, 01 Jan 0001 00:00:00 +0000https://McShelby.github.io/hugo-theme-relearn/shortcodes/notice/The notice shortcode shows four types of disclaimers to help you structure your page. -Usage {{% notice [ note | info | tip | warning ] %}} Some markup {{% /notice %}} Examples Note NoteA notice disclaimer -You can add: -multiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links other shortcodes besides notice etc. ...and even source code the possiblities are endless -Show markup {{% notice note %}} A **notice** disclaimer You can add: - multiple paragraphs - bullet point lists - _emphasized_, **bold** and even ***bold emphasized*** text - [links](https://example.Site paramhttps://McShelby.github.io/hugo-theme-relearn/shortcodes/siteparam/Mon, 01 Jan 0001 00:00:00 +0000https://McShelby.github.io/hugo-theme-relearn/shortcodes/siteparam/siteparam shortcode is used to help you print values of site params. -For instance, in this current site, the editURL variable is used in config.toml +Usage {{% notice ( note | info | tip | warning ) [ &lt;string&gt; ] %}} Some markup {{% /notice %}} The first parameter is required and indicates the type of notice. +The second parameter is optional. If provided, it will be used as the title of the notice. If not provided, then the type of notice will be used as the title.Site paramhttps://McShelby.github.io/hugo-theme-relearn/shortcodes/siteparam/Mon, 01 Jan 0001 00:00:00 +0000https://McShelby.github.io/hugo-theme-relearn/shortcodes/siteparam/The siteparam shortcode is used to help you print values of site params. +Usage {{% siteparam &lt;string %}} The first required parameter is the name of the site param to be displayed. +Examples For instance, in this current site, the editURL variable is used in config.toml [params] editURL = &#34;https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/&#34; Use the siteparam shortcode to display its value. `editURL` Value : {{% siteparam &#34;editURL&#34; %}} is displayed as -editURL Value : https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/Tabbed viewshttps://McShelby.github.io/hugo-theme-relearn/shortcodes/tabs/Mon, 01 Jan 0001 00:00:00 +0000https://McShelby.github.io/hugo-theme-relearn/shortcodes/tabs/Choose which content to see across the page. Very handy for providing code snippets for multiple languages or providing configuration in different formats. +editURL Value : https://github.Tabbed viewshttps://McShelby.github.io/hugo-theme-relearn/shortcodes/tabs/Mon, 01 Jan 0001 00:00:00 +0000https://McShelby.github.io/hugo-theme-relearn/shortcodes/tabs/Choose which content to see across the page. Very handy for providing code snippets for multiple languages or providing configuration in different formats. Code example {{&lt; tabs &gt;}} {{% tab name=&#34;python&#34; %}} ```python print(&#34;Hello World!&#34;) ``` {{% /tab %}} {{% tab name=&#34;R&#34; %}} ```R &gt; print(&#34;Hello World!&#34;) ``` {{% /tab %}} {{% tab name=&#34;Bash&#34; %}} ```Bash echo &#34;Hello World!&#34; ``` {{% /tab %}} {{&lt; /tabs &gt;}} Renders as: python R Bash print(&#34;Hello World! \ No newline at end of file diff --git a/shortcodes/mermaid/index.html b/shortcodes/mermaid/index.html index 759a7fabc3..1dc3be5298 100644 --- a/shortcodes/mermaid/index.html +++ b/shortcodes/mermaid/index.html @@ -5,18 +5,18 @@ - + Mermaid :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -32,10 +32,10 @@ Relearn
- - + + - +
    @@ -164,11 +164,11 @@ Relearn

    Mermaid is a library helping you to generate diagram and flowcharts from text, in a similar manner as Markdown.

    Usage

    Just insert your Mermaid code in the mermaid shortcode like this:

    -
    {{< mermaid [ align=(left|right|center|justify) ] >}}
+
    {{< mermaid [ align=("left"|"right"|"center"|"justify") ] >}}
 classDiagram
     Person *-- Dog
 {{< /mermaid >}}
-
    You can set an optional align attribute which defaults to center.
    
+

    You can set an optional align attribute which defaults to "center".

    If you don’t need alignment you can use the alternative syntax using code fences if you have turned off guessSyntax for the markup.highlight setting (see below):

    ```mermaid
 classDiagram
@@ -385,14 +385,14 @@ mermaidInitialize = "{ \"theme\": \"da
 
    
 
    
 
    
-
-
-
-
-
-
-
+
+
+
+
+
+
+
 
-
+
 
 
\ No newline at end of file
diff --git a/shortcodes/notice/index.html b/shortcodes/notice/index.html
index dc4ff45d03..1322fe07b7 100644
--- a/shortcodes/notice/index.html
+++ b/shortcodes/notice/index.html
@@ -5,18 +5,18 @@
 
 
 
-
+
 Notice :: Documentation for Hugo Relearn Theme
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
 
 
 
@@ -32,10 +32,10 @@ Relearn
    - - + + - +
@@ -157,10 +158,12 @@ Relearn

Notice

The notice shortcode shows four types of disclaimers to help you structure your page.

Usage

-
{{% notice [ note | info | tip | warning ] %}}
+
{{% notice ( note | info | tip | warning ) [ <string> ] %}}
 Some markup
 {{% /notice %}}
-
Examples

+

The first parameter is required and indicates the type of notice.

+

The second parameter is optional. If provided, it will be used as the title of the notice. If not provided, then the type of notice will be used as the title. For example, the title of a warning notice will be “Warning”.

+

Examples

Note

Note

A notice disclaimer

@@ -341,6 +344,24 @@ You can add:
+

Notice with Custom Title

+

You can customize the title of the notice by passing it as a second parameter.

+
+
Pay Attention to this Note!

The title is now the parameter that was provided.

+
+
+ + + +Show markup + + +
@@ -353,14 +374,14 @@ You can add:
- - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/siteparam/index.html b/shortcodes/siteparam/index.html index 168e1557e0..cabf65a994 100644 --- a/shortcodes/siteparam/index.html +++ b/shortcodes/siteparam/index.html @@ -5,18 +5,18 @@ - + Site param :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -32,10 +32,10 @@ Relearn - - + + - +
    @@ -135,7 +135,12 @@ Relearn
- +
@@ -143,7 +148,11 @@ Relearn

Site param

-

siteparam shortcode is used to help you print values of site params.

+

The siteparam shortcode is used to help you print values of site params.

+

Usage

+
{{% siteparam <string %}}
+

The first required parameter is the name of the site param to be displayed.

+

Examples

For instance, in this current site, the editURL variable is used in config.toml

[params]
   editURL = "https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/"
@@ -163,14 +172,14 @@ Relearn
 

 

 

-
-
-
-
-
-
-
+
+
+
+
+
+
+
 
-
+
 
 
\ No newline at end of file
diff --git a/shortcodes/tabs/index.html b/shortcodes/tabs/index.html
index 648de98566..189f59fbec 100644
--- a/shortcodes/tabs/index.html
+++ b/shortcodes/tabs/index.html
@@ -5,18 +5,18 @@
 
 
 
-
+
 Tabbed views :: Documentation for Hugo Relearn Theme
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
 
 
 
@@ -32,10 +32,10 @@ Relearn
- - + + - +
    @@ -274,14 +274,14 @@ from the 'default' group on a different page then all tabs will be
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/showcase/index.html b/showcase/index.html index c1929a82d2..4269d5ba2c 100644 --- a/showcase/index.html +++ b/showcase/index.html @@ -5,18 +5,18 @@ - + Showcase :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -32,10 +32,10 @@ Relearn
- - + + - +
    @@ -153,14 +153,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/tags/children/index.html b/tags/children/index.html index 499a9755b0..5401e6fd4c 100644 --- a/tags/children/index.html +++ b/tags/children/index.html @@ -6,18 +6,18 @@ - + children :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -164,14 +164,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/tags/documentation/index.html b/tags/documentation/index.html index 697513ce34..30aac76720 100644 --- a/tags/documentation/index.html +++ b/tags/documentation/index.html @@ -6,18 +6,18 @@ - + documentation :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -151,14 +151,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/tags/hidden/index.html b/tags/hidden/index.html index 3905833881..3cb66b1be3 100644 --- a/tags/hidden/index.html +++ b/tags/hidden/index.html @@ -6,18 +6,18 @@ - + hidden :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -155,14 +155,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/tags/index.html b/tags/index.html index 709cea4105..a5de23ac95 100644 --- a/tags/index.html +++ b/tags/index.html @@ -6,18 +6,18 @@ - + Tags :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -154,14 +154,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/tags/non-hidden/index.html b/tags/non-hidden/index.html index 7f0adea58e..ecc3986e6e 100644 --- a/tags/non-hidden/index.html +++ b/tags/non-hidden/index.html @@ -6,18 +6,18 @@ - + non-hidden :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -159,14 +159,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/tags/tutorial/index.html b/tags/tutorial/index.html index b92b65e6f0..28dae8978f 100644 --- a/tags/tutorial/index.html +++ b/tags/tutorial/index.html @@ -6,18 +6,18 @@ - + tutorial :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -151,14 +151,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/children-1/index.html b/yours/children-1/index.html index 0cad27fc0f..992d7db5a6 100644 --- a/yours/children-1/index.html +++ b/yours/children-1/index.html @@ -6,18 +6,18 @@ - + The one and only hidden child :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -158,14 +158,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/index.html b/yours/index.html index ff3c5339af..d3ac24cb19 100644 --- a/yours/index.html +++ b/yours/index.html @@ -6,18 +6,18 @@ - + This could be yours :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,10 +33,10 @@ Relearn
- - + + - +
    @@ -153,14 +153,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file