https://github.com/lkummer/lander
Hugo theme for landing and documentation sites.
https://github.com/lkummer/lander
Last synced: 2 months ago
JSON representation
Hugo theme for landing and documentation sites.
- Host: GitHub
- URL: https://github.com/lkummer/lander
- Owner: LKummer
- License: gpl-3.0
- Created: 2020-03-10T01:12:22.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-07T23:23:40.000Z (almost 3 years ago)
- Last Synced: 2025-12-31T17:49:14.046Z (6 months ago)
- Language: JavaScript
- Homepage: https://lkummer.github.io/Lander/
- Size: 3.31 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# Lander Hugo Theme
Hugo theme for landing and documentation sites.
## Development Guide
After cloning the project, install the required dependencies:
```shell
$ npm ci
```
### Development Server
To launch a hot reload dev server with a demo Hugo blog:
```shell
$ npm run demo:dev
```
### Storybook
To launch a hot reload Storybook instance:
```shell
$ npm run story
```
### Build
To build in development mode:
```shell
$ npm run theme:build
```
To build in production mode:
```shell
$ npm run theme:build:prod
```
To build the demo blog:
```shell
$ npm run demo:build
```
To build the documentation:
```shell
$ 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 `.toml`, for example: `fr.toml`.
A translation definition takes the following form:
```toml
[definition]
form = "template string"
```
Where `definition` is the key of the definition, `form` is the
[Go Plural Form](https://godoc.org/golang.org/x/text/feature/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.
```toml
# 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.