Installat'n

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 learn more about it by follow'n this great documentat'n fer beginners.

Create yer project

Cap'n Hugo provides a new command t' create a new website:

hugo new ship my-new-site

Aft that change into th' directory:

cd my-new-site

Every upcom'n command will be executed from inside yer new site’s root.

Install th' theme

From Download

Ye can download th' theme as .zip file an' extract it into them themes/hugo-theme-relearn directory.

Wit' Hugo’s Module System

Install th' Relearrrn theme by follow'n this documentat'n us'n Hugo’s module system.

This theme’s repository be: https://github.com/McShelby/hugo-theme-relearn.git

Us'n Git or Git Submodules

If ye install th' theme from yer git repository or GitHub, ye have several opt'ns.

If ye use th' head o' th' main branch, ye be us'n th' development version. Usually it be fully functional but can break from time t' time. We try t' fix newly introduced bugs 'n this version as soon as poss'ble.

Additionally ye can checkout one o' th' tagged versions. These tagged versions correspond t' an official releases from th' GitHub repository.

Besides th' usual version tags (eg 1.2.3) there be also tags fer th' main version (eg. 1.2.x), major version (eg. 1.x) an' th' latest (just x) released version mak'n it easier fer ye t' pin th' theme t' a certain version.

Basic Configurat'n

When build'n th' website, ye can set a theme by us'n --theme opt'n. However, we suggest ye modify th' configurat'n file hugo.toml an' set th' theme as th' default.

theme = 'hugo-theme-relearn'

theme: hugo-theme-relearn

{
   "theme": "hugo-theme-relearn"
}

Create yer Home Plank

If ye don’t create a home plank, yet, th' theme will generate a placeholder text wit' instruct'ns how t' proceed.

Start yer journey by fill'n th' home plank wit' rrrambl'n

hugo new --kind home _index.md

By open'n th' given file, ye should see th' property archetype=home on top, mean'n this plank be a home plank. Th' Relearrrn theme provides some archetypes t' create those skeleton files fer yer website.

Obviously ye better should change th' page’s rrrambl'n.

Create yer First Chapter Plank

Chapters be planks that contain other child planks. It has a special layout style an' usually just contains th' title an' a brief abstract o' th' section.

# Basics

Discover what this Cap'n Hugo theme be all about an' th' core concepts behind it.

renders as

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 archetype=chapter on top, mean'n this plank be a chapter.

Th' weight number will be used t' generate th' subtitle o' th' chapter plank, set th' number t' a consecutive value start'n at 1 fer each new chapter level.

Create yer First Rrrambl'n Planks

Then, create rrrambl'n planks inside th' previously created chapter. Here be two ways t' create rrrambl'n 'n th' chapter:

hugo new basics/first-content.md
hugo new basics/second-content/_index.md

Feel free t' edit those files by add'n some sample rrrambl'n an' replac'n th' title value 'n th' beginn'n o' th' files.

Launch'n th' Website Locally

Launch by us'n th' follow'n command:

hugo serve

Go t' http://localhost:1313

Ye should notice three th'ns:

1. Th' home plank contains some basic text.
2. Ye have a left-side Basics menu, contain'n two submenus wit' names equal t' th' title properties 'n th' previously created files.
3. When ye run hugo serve yer plank refreshes automatically when ye change a rrrambl'n plank. Neat!

Build th' Website

When yer ship be ready t' deploy, run th' follow'n command:

hugo

A public folder will be generated, contain'n all rrrambl'n an' assets fer yer website. It can now be deployed on any web server.

Now it’s time t' deploy yer plank by simply upload'n yer project t' some webserver or by us'n one o' Hugo’s many deployment opt'ns.