```
-**Hugo-theme-relearn** provides [archetypes]({{%relref "cont/archetypes.en.md" %}}) to help you create this kind of pages.
+The Relearn theme provides [archetypes]({{%relref "cont/archetypes" %}}) to help you create this kind of pages.
## Front Matter configuration
Each Hugo page has to define a [Front Matter](https://gohugo.io/content/front-matter/) in *toml*, *yaml* or *json*. This site will use *toml* in all cases.
-**Hugo-theme-relearn** uses the following parameters on top of Hugo ones :
+The Relearn theme uses the following parameters on top of Hugo ones :
```toml
+++
@@ -120,7 +120,7 @@ LastModifierEmail = ""
### Add icon to a menu entry
-In the page frontmatter, add a `pre` param to insert any HTML code before the menu label. The example below uses the Github icon.
+In the page frontmatter, add a `pre` param to insert any HTML code before the menu label. The example below uses the GitHub icon.
```toml
+++
@@ -129,7 +129,7 @@ pre = " "
+++
```
-
+
### Ordering sibling menu/page entries
@@ -146,7 +146,7 @@ weight = 5
### Using a custom title for menu entries
-By default, **Hugo-theme-relearn** will use a page's `title` attribute for the menu item (or `linkTitle` if defined).
+By default, the Relearn theme will use a page's `title` attribute for the menu item (or `linkTitle` if defined).
But a page's title has to be descriptive on its own while the menu is a hierarchy.
We've added the `menuTitle` parameter for that purpose:
@@ -174,9 +174,10 @@ The theme generates the menu based on the following rules:
- all remaining entries are not shown
You can see this feature in action on the example page for [children shortcode]({{< relref "shortcodes/children" >}}) and its children pages.
-## Homepage
-To configure your home page, you basically have three choices:
+## Your Page
+
+To configure your page, you basically have three choices:
1. Create an `_index.md` document in `content` folder and fill the file with *Markdown content*
2. Create an `index.html` file in the `static` folder and fill the file with *HTML content*
diff --git a/exampleSite/content/cont/syntaxhighlight.en-pir.md b/exampleSite/content/cont/syntaxhighlight.en-pir.md
new file mode 100644
index 0000000000..8abebf9dea
--- /dev/null
+++ b/exampleSite/content/cont/syntaxhighlight.en-pir.md
@@ -0,0 +1,5 @@
++++
+title = "Code highlight'n"
+weight = 16
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/cont/syntaxhighlight.en.md b/exampleSite/content/cont/syntaxhighlight.en.md
index 0ce5396b79..b4f88b0ea9 100644
--- a/exampleSite/content/cont/syntaxhighlight.en.md
+++ b/exampleSite/content/cont/syntaxhighlight.en.md
@@ -3,7 +3,7 @@ title = "Code highlighting"
weight = 16
+++
-Relearn theme uses [Hugo's built-in syntax highlighting](https://gohugo.io/content-management/syntax-highlighting/) for code.
+The Relearn theme uses [Hugo's built-in syntax highlighting](https://gohugo.io/content-management/syntax-highlighting/) for code.
## Markdown syntax
diff --git a/exampleSite/content/cont/tags.en-pir.md b/exampleSite/content/cont/tags.en-pir.md
new file mode 100644
index 0000000000..20a7ee01fd
--- /dev/null
+++ b/exampleSite/content/cont/tags.en-pir.md
@@ -0,0 +1,6 @@
++++
+tags = ["documentat'n", "tutorrrial"]
+title = "Tags"
+weight = 40
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/cont/tags.en.md b/exampleSite/content/cont/tags.en.md
index 98c846baf2..2df22e539c 100644
--- a/exampleSite/content/cont/tags.en.md
+++ b/exampleSite/content/cont/tags.en.md
@@ -4,7 +4,7 @@ title = "Tags"
weight = 40
+++
-*Relearn theme* supports one default taxonomy of Hugo: the *tag* feature.
+The Relearn theme supports one default taxonomy of Hugo: the *tag* feature.
## Configuration
diff --git a/exampleSite/content/credits.en-pir.md b/exampleSite/content/credits.en-pir.md
new file mode 100644
index 0000000000..3a218c2877
--- /dev/null
+++ b/exampleSite/content/credits.en-pir.md
@@ -0,0 +1,5 @@
++++
+disableToc = true
+title = "Crrredits"
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/credits.en.md b/exampleSite/content/credits.en.md
index 5986bfe563..ee500f570a 100644
--- a/exampleSite/content/credits.en.md
+++ b/exampleSite/content/credits.en.md
@@ -7,14 +7,14 @@ title = "Credits"
Special thanks to [everyone who has contributed](https://github.com/McShelby/hugo-theme-relearn/graphs/contributors) to this project.
-Many thanks to [@matcornic](https://github.com/matcornic) for his work on [hugo-theme-learn](https://github.com/matcornic/hugo-theme-learn).
+Many thanks to [@matcornic](https://github.com/matcornic) for his work on the [Learn theme](https://github.com/matcornic/hugo-theme-learn).
## Packages and libraries
-* [mermaid](https://mermaid-js.github.io/mermaid) - generation of diagram and flowchart from text in a similar manner as markdown
+* [Mermaid](https://mermaid-js.github.io/mermaid) - generation of diagram and flowchart from text in a similar manner as Markdown
* [font awesome](http://fontawesome.io/) - the iconic font and CSS framework
* [jQuery](https://jquery.com) - The Write Less, Do More, JavaScript Library
-* [jquery-svg-zoom-pan](https://github.com/DanielHoffmann/jquery-svg-pan-zoom) - enable pan and zoom in mermaid graphs
+* [jquery-svg-zoom-pan](https://github.com/DanielHoffmann/jquery-svg-pan-zoom) - enable pan and zoom in Mermaid graphs
* [lunr](https://lunrjs.com) - Lunr enables you to provide a great search experience without the need for external, server-side, search services...
* [clipboard.js](https://zenorocha.github.io/clipboard.js) - copy text to clipboard
* [modernizr](https://modernizr.com) - A JavaScript toolkit that allows web developers to use new CSS3 and HTML5 features while maintaining a fine level of control over browsers that don't support
diff --git a/exampleSite/content/shortcodes/_index.en-pir.md b/exampleSite/content/shortcodes/_index.en-pir.md
new file mode 100644
index 0000000000..b42797290b
--- /dev/null
+++ b/exampleSite/content/shortcodes/_index.en-pir.md
@@ -0,0 +1,6 @@
++++
+chapter = true
+title = "Shorrrtcodes"
+weight = 3
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/shortcodes/_index.en.md b/exampleSite/content/shortcodes/_index.en.md
index b1ed46b27d..11fb2bba72 100644
--- a/exampleSite/content/shortcodes/_index.en.md
+++ b/exampleSite/content/shortcodes/_index.en.md
@@ -14,6 +14,6 @@ But this happens to be a bad idea. Everyone uses Markdown because it's pure and
To avoid this limitations, Hugo created [shortcodes](https://gohugo.io/extras/shortcodes/). A shortcode is a simple snippet inside a page.
-**Hugo-theme-relearn** provides multiple shortcodes on top of existing ones.
+The Relearn theme provides multiple shortcodes on top of existing ones.
{{%children containerstyle="div" style="h2" description="true" %}}
diff --git a/exampleSite/content/shortcodes/attachments.en-pir.md b/exampleSite/content/shortcodes/attachments.en-pir.md
new file mode 100644
index 0000000000..e9e50df62c
--- /dev/null
+++ b/exampleSite/content/shortcodes/attachments.en-pir.md
@@ -0,0 +1,5 @@
++++
+descrption = "Th' Attachments shorrrtcode displays a list o' files attached t' a plank"
+title = "Attachments"
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/shortcodes/attachments.en.md b/exampleSite/content/shortcodes/attachments.en.md
index 4dce4b9c89..9cb0ac0a5f 100644
--- a/exampleSite/content/shortcodes/attachments.en.md
+++ b/exampleSite/content/shortcodes/attachments.en.md
@@ -1,5 +1,5 @@
+++
-description = "The Attachments shortcode displays a list of files attached to a page."
+description = "The Attachments shortcode displays a list of files attached to a page"
title = "Attachments"
+++
@@ -12,7 +12,7 @@ The Attachments shortcode displays a list of files attached to a page.
The shortcurt lists files found in a **specific folder**.
Currently, it support two implementations for pages
-1. If your page is a markdown file, attachements must be placed in a **folder** named like your page and ending with **.files**.
+1. If your page is a Markdown file, attachements must be placed in a **folder** named like your page and ending with **.files**.
> * content
> * _index.md
diff --git a/exampleSite/content/shortcodes/button.en-pir.md b/exampleSite/content/shortcodes/button.en-pir.md
new file mode 100644
index 0000000000..3bd0149613
--- /dev/null
+++ b/exampleSite/content/shortcodes/button.en-pir.md
@@ -0,0 +1,5 @@
++++
+descrption = "Nice buttons on yer plank"
+title = "Button"
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/shortcodes/button.en.md b/exampleSite/content/shortcodes/button.en.md
index 086c82a49f..b06a298b47 100644
--- a/exampleSite/content/shortcodes/button.en.md
+++ b/exampleSite/content/shortcodes/button.en.md
@@ -1,5 +1,5 @@
+++
-description = "Nice buttons on your page."
+description = "Nice buttons on your page"
title = "Button"
+++
diff --git a/exampleSite/content/shortcodes/children/_index.en-pir.md b/exampleSite/content/shortcodes/children/_index.en-pir.md
new file mode 100644
index 0000000000..fe8f598ff8
--- /dev/null
+++ b/exampleSite/content/shortcodes/children/_index.en-pir.md
@@ -0,0 +1,6 @@
++++
+alwaysopen = false
+descrption = "List th' child planks on a plank"
+title = "Children"
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/shortcodes/children/children-1/_index.en-pir.md b/exampleSite/content/shortcodes/children/children-1/_index.en-pir.md
new file mode 100644
index 0000000000..73e42b4a7e
--- /dev/null
+++ b/exampleSite/content/shortcodes/children/children-1/_index.en-pir.md
@@ -0,0 +1,7 @@
++++
+alwaysopen = false
+descrption = "This be a demo child plank"
+title = "Plank 1"
+weight = 10
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.en-pir.md b/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.en-pir.md
new file mode 100644
index 0000000000..f6ce01dc17
--- /dev/null
+++ b/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.en-pir.md
@@ -0,0 +1,7 @@
++++
+alwaysopen = false
+descrption = "This be a demo child plank"
+title = "Plank 1-1"
+
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.en-pir.md b/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.en-pir.md
new file mode 100644
index 0000000000..c5f61cfd3b
--- /dev/null
+++ b/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.en-pir.md
@@ -0,0 +1,6 @@
++++
+descrption = "This be a hidden demo child plank"
+hidden = true
+title = "Plank 1-1-1 (hidden)"
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/_index.en-pir.md b/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/_index.en-pir.md
new file mode 100644
index 0000000000..f9187830c2
--- /dev/null
+++ b/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/_index.en-pir.md
@@ -0,0 +1,5 @@
++++
+descrption = "This be a non-hidden demo child plank o' a hidden parrrent plank"
+title = "Plank 1-1-1-1"
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/_index.en-pir.md b/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/_index.en-pir.md
new file mode 100644
index 0000000000..b0ea024746
--- /dev/null
+++ b/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/_index.en-pir.md
@@ -0,0 +1,6 @@
++++
+descrption = "This be a hidden demo child plank"
+hidden = true
+title = "Plank 1-1-1-1-1 (hidden)"
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/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.en-pir.md b/exampleSite/content/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.en-pir.md
new file mode 100644
index 0000000000..67f5ba391b
--- /dev/null
+++ b/exampleSite/content/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.en-pir.md
@@ -0,0 +1,5 @@
++++
+descrption = "This be a non-hidden demo child plank on a hidden parrrent plank"
+title = "Plank 1-1-1-1-1-1"
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-2/_index.en-pir.md b/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-2/_index.en-pir.md
new file mode 100644
index 0000000000..350286ec52
--- /dev/null
+++ b/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-2/_index.en-pir.md
@@ -0,0 +1,5 @@
++++
+descrption = "This be a demo child plank"
+title = "Plank 1-1-2"
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/_index.en-pir.md b/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/_index.en-pir.md
new file mode 100644
index 0000000000..87b84bdaf9
--- /dev/null
+++ b/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/_index.en-pir.md
@@ -0,0 +1,5 @@
++++
+descrption = "This be a demo child plank"
+title = "Plank 1-1-2-1"
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/_index.en-pir.md b/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/_index.en-pir.md
new file mode 100644
index 0000000000..c5af6ee3b3
--- /dev/null
+++ b/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/_index.en-pir.md
@@ -0,0 +1,5 @@
++++
+descrption = "This be a demo child plank"
+title = "Plank 1-1-2-2"
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-3/_index.en-pir.md b/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-3/_index.en-pir.md
new file mode 100644
index 0000000000..a2b872898f
--- /dev/null
+++ b/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-3/_index.en-pir.md
@@ -0,0 +1,5 @@
++++
+descrption = "This be a demo child plank"
+title = "Plank 1-1-3"
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/shortcodes/children/children-2/_index.en-pir.md b/exampleSite/content/shortcodes/children/children-2/_index.en-pir.md
new file mode 100644
index 0000000000..738399444a
--- /dev/null
+++ b/exampleSite/content/shortcodes/children/children-2/_index.en-pir.md
@@ -0,0 +1,6 @@
++++
+alwaysopen = false
+title = "Plank 2"
+weight = 20
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/shortcodes/children/children-3/_index.en-pir.md b/exampleSite/content/shortcodes/children/children-3/_index.en-pir.md
new file mode 100644
index 0000000000..e6205fa17e
--- /dev/null
+++ b/exampleSite/content/shortcodes/children/children-3/_index.en-pir.md
@@ -0,0 +1,7 @@
++++
+alwaysopen = false
+descrption = "This be a demo child plank"
+title = "Plank 3"
+weight = 30
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/shortcodes/children/children-3/test3.en-pir.md b/exampleSite/content/shortcodes/children/children-3/test3.en-pir.md
new file mode 100644
index 0000000000..a32246b4bb
--- /dev/null
+++ b/exampleSite/content/shortcodes/children/children-3/test3.en-pir.md
@@ -0,0 +1,5 @@
++++
+descrption = "This be a plain plank test nested 'n a parrrent"
+title = "Plank 3-1"
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/shortcodes/children/children-4/_index.en-pir.md b/exampleSite/content/shortcodes/children/children-4/_index.en-pir.md
new file mode 100644
index 0000000000..ad1b2d8740
--- /dev/null
+++ b/exampleSite/content/shortcodes/children/children-4/_index.en-pir.md
@@ -0,0 +1,8 @@
++++
+alwaysopen = false
+descrption = "This be a hidden demo child plank"
+hidden = true
+title = "Plank 4 (hidden)"
+weight = 40
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/shortcodes/children/test.en-pir.md b/exampleSite/content/shortcodes/children/test.en-pir.md
new file mode 100644
index 0000000000..a9485824d4
--- /dev/null
+++ b/exampleSite/content/shortcodes/children/test.en-pir.md
@@ -0,0 +1,6 @@
++++
+descrption = "This be a plain plank test"
+title = "Plank X"
+weight = 1
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/shortcodes/expand.en-pir.md b/exampleSite/content/shortcodes/expand.en-pir.md
new file mode 100644
index 0000000000..b86a1a7df8
--- /dev/null
+++ b/exampleSite/content/shortcodes/expand.en-pir.md
@@ -0,0 +1,5 @@
++++
+descrption = "Displays an expand'ble/collaps'ble sect'n o' text on yer plank"
+title = "Expand"
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/shortcodes/expand.en.md b/exampleSite/content/shortcodes/expand.en.md
index a1dbd12b86..09c2e6db32 100644
--- a/exampleSite/content/shortcodes/expand.en.md
+++ b/exampleSite/content/shortcodes/expand.en.md
@@ -8,7 +8,7 @@ The Expand shortcode displays an expandable/collapsible section of text on your
## Usage
````go
-{{%/* expand "Does this relearn theme rock?" { "true" | "false" } */%}}
+{{%/* expand "Does this Relearn theme rock?" { "true" | "false" } */%}}
Yes!
{{%/* /expand */%}}
````
diff --git a/exampleSite/content/shortcodes/include.en-pir.md b/exampleSite/content/shortcodes/include.en-pir.md
new file mode 100644
index 0000000000..8782676ac8
--- /dev/null
+++ b/exampleSite/content/shortcodes/include.en-pir.md
@@ -0,0 +1,5 @@
++++
+descrption = "Displays content from other Marrrkdown files"
+title = "Include"
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/shortcodes/include.en.md b/exampleSite/content/shortcodes/include.en.md
index 472af2e4b2..ff3e6dc986 100644
--- a/exampleSite/content/shortcodes/include.en.md
+++ b/exampleSite/content/shortcodes/include.en.md
@@ -1,9 +1,9 @@
+++
-description = "Displays content from other markdown files"
+description = "Displays content from other Markdown files"
title = "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.
+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
diff --git a/exampleSite/content/shortcodes/mermaid.en-pir.md b/exampleSite/content/shortcodes/mermaid.en-pir.md
new file mode 100644
index 0000000000..5f20eab4fe
--- /dev/null
+++ b/exampleSite/content/shortcodes/mermaid.en-pir.md
@@ -0,0 +1,5 @@
++++
+descrption = "Generrrat'n o' diagrrram an' flowcharrrt frrrom text 'n a similar manner as Marrrkdown"
+title = "Merrrmaid"
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/shortcodes/mermaid.en.md b/exampleSite/content/shortcodes/mermaid.en.md
index 88f3097b4d..72ec52ffb2 100644
--- a/exampleSite/content/shortcodes/mermaid.en.md
+++ b/exampleSite/content/shortcodes/mermaid.en.md
@@ -1,5 +1,5 @@
+++
-description = "Generation of diagram and flowchart from text in a similar manner as markdown"
+description = "Generation of diagram and flowchart from text in a similar manner as Markdown"
title = "Mermaid"
+++
@@ -7,7 +7,7 @@ title = "Mermaid"
## Usage
-Just insert your mermaid code in the `mermaid` shortcode like this:
+Just insert your Mermaid code in the `mermaid` shortcode like this:
````go
{{}}
@@ -92,7 +92,7 @@ sequenceDiagram
{{< mermaid >}}
gantt
dateFormat YYYY-MM-DD
- title Adding GANTT diagram functionality to mermaid
+ title Adding GANTT diagram functionality to Mermaid
section A section
Completed task :done, des1, 2014-01-06,2014-01-08
Active task :active, des2, 2014-01-09, 3d
@@ -104,7 +104,7 @@ gantt
Create tests for parser :crit, active, 3d
Future task in critical line :crit, 5d
Create tests for renderer :2d
- Add to mermaid :1d
+ Add to Mermaid :1d
{{< /mermaid >}}
{{% expand "Show markup" "true" %}}
@@ -112,7 +112,7 @@ gantt
{{}}
gantt
dateFormat YYYY-MM-DD
- title Adding GANTT diagram functionality to mermaid
+ title Adding GANTT diagram functionality to Mermaid
section A section
Completed task :done, des1, 2014-01-06,2014-01-08
Active task :active, des2, 2014-01-09, 3d
@@ -124,7 +124,7 @@ gantt
Create tests for parser :crit, active, 3d
Future task in critical line :crit, 5d
Create tests for renderer :2d
- Add to mermaid :1d
+ Add to Mermaid :1d
{{}}
````
{{% /expand %}}
@@ -199,11 +199,11 @@ stateDiagram-v2
## Configuration
-Mermaid is configured with default settings. You can customize mermaids default settings for all of your files thru a JSON object in your `config.toml` or override these settings sidewise thru your pages frontmatter.
+Mermaid is configured with default settings. You can customize Mermaid's default settings for all of your files thru a JSON object in your `config.toml` or override these settings sidewise thru your pages frontmatter.
-This JSON object is forwarded into mermaids `mermaid.initialize()` function.
+This JSON object is forwarded into Mermaid's `mermaid.initialize()` function.
-See [mermaid documentation](http://mermaid-js.github.io/mermaid/getting-started/Setup.html#mermaidapi-configuration-defaults) for all allowed settings.
+See [Mermaid documentation](http://mermaid-js.github.io/mermaid/getting-started/Setup.html#mermaidapi-configuration-defaults) for all allowed settings.
### Example
diff --git a/exampleSite/content/shortcodes/notice.en-pir.md b/exampleSite/content/shortcodes/notice.en-pir.md
new file mode 100644
index 0000000000..98c1c43ec1
--- /dev/null
+++ b/exampleSite/content/shortcodes/notice.en-pir.md
@@ -0,0 +1,5 @@
++++
+descrption = "Disclaimerrrs t' help ye strrructurrre yer plank"
+title = "Notice"
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/shortcodes/siteparam.en-pir.md b/exampleSite/content/shortcodes/siteparam.en-pir.md
new file mode 100644
index 0000000000..084146bcd5
--- /dev/null
+++ b/exampleSite/content/shortcodes/siteparam.en-pir.md
@@ -0,0 +1,5 @@
++++
+descrption = "Get value o' ship parrrams varrriables 'n yer plank"
+title = "Ship param"
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/shortcodes/siteparam.en.md b/exampleSite/content/shortcodes/siteparam.en.md
index 458036f616..5403c8d58f 100644
--- a/exampleSite/content/shortcodes/siteparam.en.md
+++ b/exampleSite/content/shortcodes/siteparam.en.md
@@ -1,5 +1,5 @@
+++
-description = "Get value of site params variables in your page."
+description = "Get value of site params variables in your page"
title = "Site param"
+++
diff --git a/exampleSite/content/shortcodes/tabs.en-pir.md b/exampleSite/content/shortcodes/tabs.en-pir.md
new file mode 100644
index 0000000000..bfbe015e13
--- /dev/null
+++ b/exampleSite/content/shortcodes/tabs.en-pir.md
@@ -0,0 +1,5 @@
++++
+descrption = "Synchr'nize select'n o' content 'n different tabbed views"
+title = "Tabbed views"
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/showcase.en-pir.md b/exampleSite/content/showcase.en-pir.md
new file mode 100644
index 0000000000..013c1b0488
--- /dev/null
+++ b/exampleSite/content/showcase.en-pir.md
@@ -0,0 +1,5 @@
++++
+disableToc = true
+title = "Showcase"
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/yours/_index.en-pir.md b/exampleSite/content/yours/_index.en-pir.md
new file mode 100644
index 0000000000..8c1f2ed730
--- /dev/null
+++ b/exampleSite/content/yours/_index.en-pir.md
@@ -0,0 +1,7 @@
++++
+chapter = true
+hidden = true
+title = "This could be yers"
+weight = 4
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/content/yours/children-1/_index.en-pir.md b/exampleSite/content/yours/children-1/_index.en-pir.md
new file mode 100644
index 0000000000..53dd0c9514
--- /dev/null
+++ b/exampleSite/content/yours/children-1/_index.en-pir.md
@@ -0,0 +1,5 @@
++++
+hidden = true
+title = "Th' one an' only hidden child"
++++
+{{< piratify >}}
\ No newline at end of file
diff --git a/exampleSite/layouts/shortcodes/piratify.html b/exampleSite/layouts/shortcodes/piratify.html
new file mode 100644
index 0000000000..0f96d88505
--- /dev/null
+++ b/exampleSite/layouts/shortcodes/piratify.html
@@ -0,0 +1,101 @@
+{{ $langsrc := .Get 1 | default "en" }}
+{{ $langtrg := .Page.Language.Lang }}
+{{ $words := dict
+ "Hugo" "Cap'n Hugo"
+ "Info" "Ahoi"
+ "Note" "Avast"
+ "Tip" "Smarrrt Arrrse"
+ "Warning" "Arrr"
+ "good" "bloody"
+ "shortcode" "shorrrtcode"
+ "Shortcode" "Shorrrtcode"
+ "shortcodes" "shorrrtcodes"
+ "Shortcodes" "Shorrrtcodes"
+ "Mermaid" "Merrrmaid"
+ "Markdown" "Marrrkdown"
+ "Markup" "Marrrkup"
+ "markup" "marrrkup"
+ "for" "fer"
+ "Your" "Yer"
+ "your" "yer"
+ "You" "Ye"
+ "you" "ye"
+ "the" "th'"
+ "The" "Th'"
+ "is" "be"
+ "Is" "Be"
+ "are" "be"
+ "Are" "Be"
+ "Of" "O'"
+ "of" "o'"
+ "To" "T'"
+ "to" "t'"
+ "in" "'n"
+ "With" "Wit'"
+ "with" "wit'"
+ "Where" "Whar'"
+ "where" "whar'"
+ "After" "Aft"
+ "after" "aft"
+ "And" "An'"
+ "and" "an'"
+ "Load" "Board"
+ "load" "board"
+ "Loaded" "Boarded"
+ "loaded" "boarded"
+ "Content" "Rambling"
+ "content" "rambling"
+ "icon" "ay'con"
+ "Icon" "Ay'con"
+ "icons" "ay'cons"
+ "Icons" "Ay'cons"
+ "syntax" "rules"
+ "Syntax" "Rules"
+ "Site" "Ship"
+ "site" "ship"
+ "Page" "Plank"
+ "page" "plank"
+ "Pages" "Planks"
+ "pages" "planks"
+ "Relearn" "Relearrrn"
+ "Learn" "Learrrn"
+}}
+
+{{ $specials := dict
+ "(\\w)ing([\\s\\n<.,;?!:])" "'n"
+ "(\\w)ings([\\s\\n<.,;?!:])" "'ns"
+ "(\\w)tion([\\s\\n<.,;?!:])" "t'n"
+ "(\\w)tions([\\s\\n<.,;?!:])" "t'ns"
+ "(\\w)(?:[aeiou])ble([\\s\\n<.,;?!:])" "'ble"
+ "(\\w)(?:[aeiou])mize([\\s\\n<.,;?!:])" "'mize"
+ "(\\w)(?:[aeiou])mizes([\\s\\n<.,;?!:])" "'mizes"
+ "(\\w)(?:[aeiou])nize([\\s\\n<.,;?!:])" "'nize"
+ "(\\w)(?:[aeiou])nizes([\\s\\n<.,;?!:])" "'nizes"
+ "(.)=\"/([^\".]*?\")" (printf "=\"/%s/" $langtrg)
+}}
+
+{{ $fix := dict
+ "warn'n" "warning"
+ "sect'n" "section"
+ "n Cap'n" "n"
+ "Documentat'n fer Cap'n Hugo Relearrrn Theme" "Documentation for Hugo Relearn Theme"
+ "Avast right o' John" "Note right of John"
+}}
+
+{{ $c := "" }}
+{{ range .Page.Translations }}
+ {{ if eq .Language.Lang $langsrc }}
+ {{/* $file | readFile | safeHTML */}}
+ {{ $c = .Content }}
+ {{ range $from, $to := $words }}
+ {{ $c = replaceRE (printf "([\\s\\n>])%s([\\s\\n<.,;?!:])" $from) (printf "${1}%s${2}" $to) $c }}
+ {{ end }}
+ {{ range $from, $to := $specials }}
+ {{ $c = replaceRE $from (printf "${1}%s${2}" $to) $c }}
+ {{ end }}
+ {{ range $from, $to := $fix }}
+ {{ $c = replace $c $from $to }}
+ {{ end }}
+ {{ end }}
+{{ end }}
+{{ $c | safeHTML }}
\ No newline at end of file
diff --git a/i18n/en-pir.toml b/i18n/en-pir.toml
new file mode 100644
index 0000000000..6b893babea
--- /dev/null
+++ b/i18n/en-pir.toml
@@ -0,0 +1,47 @@
+[Search-placeholder]
+other = "Searrrch..."
+
+[Clear-History]
+other = "Clear Historrry"
+
+[Attachments-label]
+other = "Attachments"
+
+[title-404]
+other = "Errror"
+
+[message-404]
+other = "Woops. Looks like this plank doesn't exist ¯\\_(ツ)_/¯."
+
+[Go-to-homepage]
+other = "Go t' homeplank"
+
+[Edit-this-page]
+other = "Edit this plank"
+
+[Shortcuts-Title]
+other = "Morrre"
+
+[Expand-title]
+other = "Expand me..."
+
+[Byte-symbol]
+other = "B"
+
+[Kilobyte-symbol]
+other = "KB"
+
+[Megabyte-symbol]
+other = "MB"
+
+[note]
+other = "Avast"
+
+[info]
+other = "Ahoi"
+
+[tip]
+other = "Smarrrt arrrse"
+
+[warning]
+other = "Arrr"
diff --git a/layouts/index.html b/layouts/index.html
index 6e76034674..7f0bac1017 100644
--- a/layouts/index.html
+++ b/layouts/index.html
@@ -8,7 +8,7 @@
{{else}}
Customize your own home page
- The site is working. Don't forget to customize this homepage with your own. You typically have 3 choices :
+ The site is working. Don't forget to customize this page with your own. You typically have 3 choices :
- 1. Create an _index.md document in content folder and fill it with Markdown content