zola/docs/content/themes/sam/index.md

168 lines
3.5 KiB
Markdown
Raw Normal View History

2019-07-12 22:03:19 +00:00
+++
title = "sam"
description = "A Simple and Minimalist theme with a focus on typography and content."
template = "theme.html"
date = 2019-07-02T17:55:24+02:00
[extra]
created = 2019-07-02T17:55:24+02:00
updated = 2019-07-02T17:55:24+02:00
repository = "https://github.com/janbaudisch/zola-sam.git"
homepage = "https://github.com/janbaudisch/zola-sam"
minimum_version = "0.4.0"
license = "AGPL-3.0"
demo = "https://zola-sam.janbaudisch.dev"
[extra.author]
name = "Jan Baudisch"
homepage = "https://janbaudisch.dev"
+++
[![Build Status][build-img]][build-url]
[![Demo][demo-img]][demo-url]
# Sam
> A Simple and Minimalist theme with a focus on typography and content.
>
> [Zola][zola] port of [hugo-theme-sam][hugo-sam].
![Screenshot](screenshot.png)
## Original
This is a port of the original [hugo-theme-sam][hugo-sam] theme for Hugo ([License][upstream-license]).
See [`upstream`][upstream] for source code take from there.
## Installation
The easiest way to install this theme is to either clone it ...
```
git clone https://github.com/janbaudisch/zola-sam.git themes/sam
```
... or to use it as a submodule.
```
git submodule add https://github.com/janbaudisch/zola-sam.git themes/sam
```
Either way, you will have to enable the theme in your `config.toml`.
```toml
theme = "sam"
```
## Options
See [`config.toml`][config] for an example configuration.
### Menu
The menu on the index page is created as follows: If the `sam_menu` variable is set, it gets used.
```toml
[extra]
sam_menu = [
{ text = "posts", link = "/posts" },
{ text = "about", link = "/about" },
{ text = "github", link = "https://github.com" }
]
```
If it is not set, all sections under `content` will get linked.
#### Bottom menu
This variable decides wether the menu - as mentioned above - will also be displayed at the bottom of pages.
Default: `false`
```toml
[extra]
sam_bottom_menu = true
```
### `home`
Sets the name for all links referring to the home page in the menus and the 404 page.
Default: `home`
```toml
[extra]
home = "home"
```
### Date format
Specifies how to display dates. The format is described [here][date-format-docs].
Default: `%a %b %e, %Y`
```toml
[extra]
date_format = "%a %b %e, %Y"
```
### Word count and reading time
You can enable or disable word count and reading time for posts across the whole site:
Default: `true` (both)
```toml
[extra]
show_word_count = true
show_reading_time = true
```
If enabled, you can opt-out per page via front-matter:
Default: `false` (both)
```
+++
[extra]
hide_word_count = true
hide_reading_time = true
+++
```
### Disable page header
If you want to disable the complete header of a page (for example a page which is explicitly not a post), you can do so via front-matter:
Default: `false`
```
+++
[extra]
no_header = true
+++
```
### Footer
To place some text at the end of pages, set the following:
```toml
[extra.sam_footer]
text = "Some footer text."
```
[build-img]: https://travis-ci.com/janbaudisch/zola-sam.svg?branch=master
[build-url]: https://travis-ci.com/janbaudisch/zola-sam
[demo-img]: https://img.shields.io/badge/demo-live-green.svg
[demo-url]: https://zola-sam.janbaudisch.dev
[zola]: https://getzola.org
[hugo-sam]: https://github.com/victoriadotdev/hugo-theme-sam
[upstream]: https://github.com/janbaudisch/zola-sam/blob/master/upstream
[upstream-license]: https://github.com/janbaudisch/zola-sam/blob/master/upstream/LICENSE
[config]: https://github.com/janbaudisch/zola-sam/blob/master/config.toml
[date-format-docs]: https://docs.rs/chrono/latest/chrono/format/strftime/index.html