lkummer/lander

Hugo theme for landing and documentation sites.

Lander Hugo Theme

Hugo theme for landing and documentation sites.

Development Guide

After cloning the project, install the required dependencies:

$ npm ci

Development Server

To launch a hot reload dev server with a demo Hugo blog:

$ npm run demo:dev

Storybook

To launch a hot reload Storybook instance:

$ npm run story

Build

To build in development mode:

$ npm run theme:build

To build in production mode:

$ npm run theme:build:prod

To build the demo blog:

$ npm run demo:build

To build the documentation:

$ npm run doc:build

Built files can be found in the dist folder.

Translation Guide

The translation files are in the i18n folder. Translation files should be named in the form <language subtag>.toml, for example: fr.toml.

A translation definition takes the following form:

[definition]
    form = "template string"

Where definition is the key of the definition, form is the Go Plural Form of the argument passed to the template string and template string is the translated string.

The direction definition is a special definition used to configure whether the language requires left-to-right or right-to-left styling by being set to ltr or rtl respectively.

# Example direction definition:
[direction]
    other = "ltr"

If the direction definition is not set to either ltr or rtl, Hugo will emit an error and refuse to build.