planks orrrganizat'n

In Cap'n Hugo, planks be th' core o' yer ship. Once it be configured, planks be definitely th' added value t' yer documentat'n ship.

Folders

Org'nize yer ship like any other Cap'n Hugo project. Typically, ye will have a rrrambl'n folder wit' all yer planks.

rrrambl'n
β”œβ”€β”€ level-one
β”‚   β”œβ”€β”€ level-two
β”‚   β”‚   β”œβ”€β”€ level-three
β”‚   β”‚   β”‚   β”œβ”€β”€ level-four
β”‚   β”‚   β”‚   β”‚   β”œβ”€β”€ _index.md       <-- /level-one/level-two/level-three/level-four
β”‚   β”‚   β”‚   β”‚   β”œβ”€β”€ page-4-a.md     <-- /level-one/level-two/level-three/level-four/page-4-a
β”‚   β”‚   β”‚   β”‚   β”œβ”€β”€ page-4-b.md     <-- /level-one/level-two/level-three/level-four/page-4-b
β”‚   β”‚   β”‚   β”‚   └── page-4-c.md     <-- /level-one/level-two/level-three/level-four/page-4-c
β”‚   β”‚   β”‚   β”œβ”€β”€ _index.md           <-- /level-one/level-two/level-three
β”‚   β”‚   β”‚   β”œβ”€β”€ page-3-a.md         <-- /level-one/level-two/level-three/page-3-a
β”‚   β”‚   β”‚   β”œβ”€β”€ page-3-b.md         <-- /level-one/level-two/level-three/page-3-b
β”‚   β”‚   β”‚   └── page-3-c.md         <-- /level-one/level-two/level-three/page-3-c
β”‚   β”‚   β”œβ”€β”€ _index.md               <-- /level-one/level-two
β”‚   β”‚   β”œβ”€β”€ page-2-a.md             <-- /level-one/level-two/page-2-a
β”‚   β”‚   β”œβ”€β”€ page-2-b.md             <-- /level-one/level-two/page-2-b
β”‚   β”‚   └── page-2-c.md             <-- /level-one/level-two/page-2-c
β”‚   β”œβ”€β”€ _index.md                   <-- /level-one
β”‚   β”œβ”€β”€ page-1-a.md                 <-- /level-one/page-1-a
β”‚   β”œβ”€β”€ page-1-b.md                 <-- /level-one/page-1-b
β”‚   └── page-1-c.md                 <-- /level-one/page-1-c
β”œβ”€β”€ _index.md                       <-- /
└── page-top.md                     <-- /page-top
Avast

_index.md be required 'n each folder, it’s yer β€œfolder home page”

Create yer project

Th' follow'n steps be here t' help ye initialize yer new website. If ye don’t know Cap'n Hugo at all, we strongly suggest ye t' train by follow'n great documentat'n fer beginners.

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.