Woops. Looks like this page doesn't exist ¯\_(ツ)_/¯.
Go to homepage
The Mermaid configuration parameters can also be set on a specific page. In this case, the global parameter would be overwritten by the local one. See Mermaid for additional documentation.
Example: Mermaid is globally disabled. By default it won’t be loaded by any page. @@ -261,21 +261,21 @@ landingPageName = "<i class='fas fa-home
Example:
Mermaid is globally disabled. By default it won’t be loaded by any page. @@ -261,21 +261,21 @@ landingPageName = "<i class='fas fa-home
img
This document shows you what’s new in the latest release. For a detailed list of changes, see the history page.
Breaking: A change that requires action by you after upgrading to assure the site is still functional.
Change: A change in default behavior. This may requires action by you / may or may not be revertable by configuration.
New: Marks new behavior you might find interesting or comes configurable.
Change: Although never officially documented, this release removes the font Novacento/Novecento from the release. If you use it in an overwritten CSS please replace it with Work Sans. This change was necessary as Novacento did not provide all Latin special characters and lead to mixed styled character text eg. for czech.
Novacento
Novecento
Work Sans
New: The theme now supports favicons served from static/images/ named as favicon or logo in SVG, PNG or ICO format out of the box. An overridden partial layouts/partials/favicon.html may not be necessary anymore in most cases.
static/images/
favicon
logo
layouts/partials/favicon.html
New: You can hide the table of contents menu for the whole site by setting the disableToc option in your config.toml. For an example see the example configuration.
disableToc
config.toml
notice
baseURL
canonifyURLs=true
Change: Creation of customized stylesheets was simplified down to only contain the CSS variables. Everything else can and should be deleted from your custom stylesheet to assure everything works fine. For the predefined stylesheet variants, this change is already included. The documentation was adjusted accordingly.
New: Hidden pages are displayed by default in their according tags page. You can now turn off this behavior by setting disableTagHiddenPages=true in your config.toml.
disableTagHiddenPages=true
New: You can define the expansion state of your menus for the whole site by setting the alwaysopen option in your config.toml. Please see further documentation for possible values and default behavior.
alwaysopen
New: New frontmatter ordersectionsby option to change immediate children sorting in menu and children shortcode. Possible values are title or weight.
ordersectionsby
children
title
weight
Change: A page without a title will be treated as hidden=true.
hidden=true
New: You can define the expansion state of your menus in the frontmatter. Please see further documentation for possible values and default behavior.
New: New partials for defining pre/post content for menu items and the content. See documentation for further reading.
New: Shortcode children with new parameter containerstyle.
containerstyle
New: New shortcode include to include arbitrary file content into a page.
include
expand
Mermaid
GFM, or “GitHub Flavored Markdown” also supports syntax highlighting. To activate it, usually you simply add the file extension of the language you want to use directly after the first code “fence”, ```js, and syntax highlighting will automatically be applied in the rendered HTML.
```js
See Code Highlighting for additional documentation.
For example, to apply syntax highlighting to JavaScript code:
```js grunt.initConfig({ @@ -678,21 +678,21 @@ grunt.initConfig({
Hugo provides a new command to create a new website.
new
hugo new site <new_project> -
The Relearn theme provides archetypes to help you create this kind of pages.
Each Hugo page has to define a Front Matter in toml, yaml or json. This site will use toml in all cases.
The Relearn theme uses the following parameters on top of Hugo ones :
alwaysopen=true
You can see this feature in action on the example page for children shortcode and its children pages.
To configure your page, you basically have three choices:
See what’s new within the latest update.
To get support, feel free to open a new discussion topic or issue in the official repository on GitHub.
This theme is licensed under the MIT License.
This theme would not be possible without the work of many others. See the credits for a detailed list.
Woops. Looks like this plank doesn't exist ¯\_(ツ)_/¯.
Go t' homeplank
Th' Merrrmaid configurat'n parameters can also be set on a specific plank. In this case, th' global parameter would be overwritten by th' local one. See Merrrmaid fer additional documentat'n.
Example: Merrrmaid be globally disabled. By default it won’t be boarded by any plank. @@ -247,27 +247,27 @@ default values: landingPageURL = "/" landingPageName = "<i class='fas fa-home'></i> Home" Th' home button be go'n t' look like this: - +
Merrrmaid be globally disabled. By default it won’t be boarded by any plank. @@ -247,27 +247,27 @@ default values:
landingPageURL = "/" landingPageName = "<i class='fas fa-home'></i> Home"
Th' home button be go'n t' look like this:
[params] # Change default color scheme wit' a variant one. Can be empty, "red", "blue", "green". themeVariant = "" -
[params] # Change default color scheme wit' a variant one. Can be empty, "red", "blue", "green". themeVariant = "red" -
[params] # Change default color scheme wit' a variant one. Can be empty, "red", "blue", "green". themeVariant = "blue" -
[params] # Change default color scheme wit' a variant one. Can be empty, "red", "blue", "green". themeVariant = "green" -
First, create a new CSS file 'n yer local static/css folder prefixed by theme (e.g. wit' mine theme static/css/theme-mine.css). Copy th' follow'n rambl'n an' modify colors 'n CSS variables.
static/css
theme
static/css/theme-mine.css
:root { @@ -240,21 +240,21 @@ Ye could use an img HTML tag an' reference an image created under t
renders as
Th' Relearrrn theme provides archetypes t' create skeletons fer yer website. Begin by creat'n yer first chapter plank wit' th' follow'n command
hugo new --kind chapter basics/_index.md
By open'n th' given file, ye should see th' property chapter=true on top, mean'n this plank be a chapter.
chapter=true
This document shows ye what’s new 'n th' latest release. For a detailed list o' changes, see th' history plank.
Break'n: A change that requires act'n by ye aft upgrad'n t' assure th' ship be still functional.
Change: A change 'n default behavior. This may requires act'n by ye / may or may not be revert'ble by configurat'n.
New: Marks new behavior ye might find interest'n or comes configur'ble.
Change: Although never officially documented, this release removes th' font Novacento/Novecento from th' release. If ye use it 'n an overwritten CSS please replace it wit' Work Sans. This change was necessary as Novacento did not provide all Latin special characters an' lead t' mixed styled character text eg. fer czech.
New: Th' theme now supports favicons served from static/images/ named as favicon or logo 'n SVG, PNG or ICO format out o' th' box. An overridden partial layouts/partials/favicon.html may not be necessary anymore 'n most cases.
New: Ye can hide th' t'ble o' contents menu fer th' whole ship by sett'n th' disableToc opt'n 'n yer config.toml. For an example see th' example configurat'n.
Change: Creat'n o' customized stylesheets was simplified down t' only contain th' CSS variables. Everyth'n else can an' should be deleted from yer custom stylesheet t' assure everyth'n works fine. For th' predefined stylesheet variants, this change be already included. Th' documentat'n was adjusted accordingly.
New: Hidden planks be displayed by default 'n their accord'n tags plank. Ye can now turn off this behavior by sett'n disableTagHiddenPages=true 'n yer config.toml.
New: Ye can define th' expansion state o' yer menus fer th' whole ship by sett'n th' alwaysopen opt'n 'n yer config.toml. Please see further documentat'n fer poss'ble values an' default behavior.
New: New frontmatter ordersectionsby opt'n t' change immediate children sort'n 'n menu an' children shorrrtcode. Poss'ble values be title or weight.
Change: A plank without a title will be treated as hidden=true.
New: Ye can define th' expansion state o' yer menus 'n th' frontmatter. Please see further documentat'n fer poss'ble values an' default behavior.
New: New partials fer defin'n pre/post rambl'n fer menu items an' th' rambl'n. See documentat'n fer further read'n.
New: Shorrrtcode children wit' new parameter containerstyle.
New: New shorrrtcode include t' include arbitrary file rambl'n into a plank.
Merrrmaid
Thanks t' th' simplicity o' Cap'n Hugo, this plank be as empty as this theme needs requirements.
Just download latest version o' Cap'n Hugo binary fer yer OS (Windows, Linux, Mac) : it’s that simple.
Aft learn'n how Cap'n Hugo handle multilingual websites, define yer languages 'n yer config.toml file.
For example wit' current English an' Piratized English website.
GFM, or “GitHub Flavored Markdown” also supports rules highlight'n. T' activate it, usually ye simply add th' file extension o' th' language ye want t' use directly aft th' first code “fence”, ```js, an' rules highlight'n will automatically be applied 'n th' rendered HTML.
See Code Highlight'n fer additional documentat'n.
For example, t' apply rules highlight'n t' JavaScript code:
```js grunt.initConfig({ @@ -623,21 +623,21 @@ grunt.initConfig({
Th' Relearrrn theme defines two types o' planks. Default an' Chapter. Both can be used at any level o' th' documentat'n, th' only difference be'n layout display.
A Chapter displays a plank meant t' be used as introduct'n fer a set o' child planks. Commonly, it contains a simple title an' a catch line t' define rambl'n that can be found under it. Ye can define any HTML as prefix fer th' menu. In th' example below, it’s just a number but that could be an ay'con.
+++ chapter = true pre = "<b>1. </b>" @@ -195,7 +195,7 @@ weight = 5 Discover what this Cap'n Hugo theme be all about an' th' core-concepts behind it.
T' tell th' Relearrrn theme t' consider a plank as a chapter, set chapter=true 'n th' Front Matter o' th' plank.
A Default plank be any other rambl'n plank.
+++ title = "Installation" weight = 15 @@ -204,7 +204,7 @@ weight = 15 Create yer project Cap'n Hugo provides a new command t' create a new website. hugo new ship <new_project> -Th' Relearrrn theme provides archetypes t' help ye create this kind o' planks. +
Cap'n Hugo provides a new command t' create a new website.
hugo new ship <new_project> -
Th' Relearrrn theme provides archetypes t' help ye create this kind o' planks.
Each Cap'n Hugo plank has t' define a Front Matter 'n toml, yaml or json. This ship will use toml 'n all cases.
Th' Relearrrn theme uses th' follow'n parameters on top o' Cap'n Hugo ones :
Cap'n Hugo provides a flex'ble way t' handle order fer yer planks.
Th' simplest way be t' set weight parameter t' a number.
Ye can see this feature 'n act'n on th' example plank fer children shorrrtcode an' its children planks.
T' configure yer plank, ye basically have three choices:
See what’s new within th' latest update.
T' get support, feel free t' open a new discussion topic or issue 'n th' official repository on GitHub.
This theme be licensed under th' MIT License.
This theme would not be poss'ble without th' work o' many others. See th' credits fer a detailed list.
Th' Attachments shorrrtcode displays a list o' files attached t' a plank.
{{%attachments style="grey" /%}} @@ -278,12 +278,12 @@ Currently, it support two implementat'ns fer planks 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) +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) {{%attachments style="blue" /%}} @@ -291,12 +291,12 @@ Currently, it support two implementat'ns fer planks 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) +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) {{%attachments style="green" /%}} @@ -304,12 +304,12 @@ Currently, it support two implementat'ns fer planks 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) +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) - - + + - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/button/index.html b/pir/shortcodes/button/index.html index 45682db2bd..4634e731cc 100644 --- a/pir/shortcodes/button/index.html +++ b/pir/shortcodes/button/index.html @@ -7,26 +7,26 @@ "> - + Button :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + - - + + - + Relearn @@ -35,57 +35,57 @@ Relearn - - - + + +
{{%attachments style="blue" /%}} @@ -291,12 +291,12 @@ Currently, it support two implementat'ns fer planks 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) +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) {{%attachments style="green" /%}} @@ -304,12 +304,12 @@ Currently, it support two implementat'ns fer planks 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) +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) - - + +
{{%attachments style="green" /%}} @@ -304,12 +304,12 @@ Currently, it support two implementat'ns fer planks 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) +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)
This be a hidden demo child plank. This plank an' all its children be hidden 'n th' menu, arrow navigat'n an' children shorrrtcode as long as ye aren’t view'n this plank or its children directly.
This be a non-hidden demo child plank o' a hidden parent plank wit' a hidden child. Ye can still access th' hidden child directly or via th' search.
This be a plain demo child plank.
This be a demo child plank wit' a hidden child. Ye can still access th' hidden child directly or via th' search.
This be a demo child plank.
{{% children %}}
{{% children description="true" %}}
This be a plain plank test, an' th' beginn'n o' a YAML multiline descript'n...
This be a demo child plank
This be a demo child plank wit' no descript'n. So its rambl'n be used as descript'n.
{{% children depth="999" showhidden="true" %}}
{{% children containerstyle="div" style="h2" depth="3" description="true" %}}
This be a plain plank test nested 'n a parent
{{% children containerstyle="div" style="div" depth="999" %}}
T' avoid this limitat'ns, Cap'n Hugo created shorrrtcodes. A shorrrtcode be a simple snippet inside a plank.
Th' Relearrrn theme provides multiple shorrrtcodes on top o' exist'n ones.
Th' Attachments shorrrtcode displays a list o' files attached t' a plank
Nice buttons on yer plank
List th' child planks o' a plank
Displays an expandable/collaps'ble section o' text on yer plank
Displays rambl'n from other Marrrkdown files
Generat'n o' diagram an' flowchart from text 'n a similar manner as Marrrkdown
Disclaimers t' help ye structure yer plank
Get value o' ship params variables 'n yer plank
Synchr'nize select'n o' rambl'n 'n different tabbed views
