Arrr! ☠ Pirrrates ☠

Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.

Chapter 3

Shorrrtcodes

Cap'n Hugo uses Marrrkdown fer its simple rrrambl'n format. However, there be a lot o' th'ns that Marrrkdown doesn’t support well. Ye could use pure HTML t' expand possibilities.

But this happens t' be a bad idea. Everyone uses Marrrkdown because it’s pure an' simple t' read even non-rendered. Ye should avoid HTML t' keep it as simple as poss'ble.

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.

Attachments

List o' files attached t' a plank

Button

Nice buttons on yer plank

Children

List th' child planks o' a plank

Expand

Displays an expandable/collaps'ble section o' text on yer plank

Include

Displays rrrambl'n from other Marrrkdown files

Merrrmaid

Generat'n o' diagram an' flowchart from text 'n a similar manner as Marrrkdown

Notice

Disclaimers t' help ye structure yer plank

Ship param

Get value o' ship params variables 'n yer plank

Swagger

Adds UI fer yer Swagger / OpenAPI Specificat'ns

Tabbed views

Synchr'nize select'n o' rrrambl'n 'n different tabbed views