mirror of
https://github.com/pawroman/zola-theme-terminimal.git
synced 2025-01-08 19:51:06 +01:00
Merge 3abae6b153
into 7f630a4e31
This commit is contained in:
commit
cde5c2b82d
49
README.md
49
README.md
|
@ -1,3 +1,4 @@
|
||||||
|
<!-- omit from toc -->
|
||||||
# Terminimal
|
# Terminimal
|
||||||
|
|
||||||
[![Build Status](https://github.com/pawroman/zola-theme-terminimal/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/pawroman/zola-theme-terminimal/actions/workflows/pages/pages-build-deployment)
|
[![Build Status](https://github.com/pawroman/zola-theme-terminimal/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/pawroman/zola-theme-terminimal/actions/workflows/pages/pages-build-deployment)
|
||||||
|
@ -12,6 +13,7 @@ Tested with Zola v0.19.2.
|
||||||
|
|
||||||
Please note that earlier (and older) versions might not work because of breaking changes across Zola versions.
|
Please note that earlier (and older) versions might not work because of breaking changes across Zola versions.
|
||||||
|
|
||||||
|
<!-- omit from toc -->
|
||||||
#### Fork disclaimer
|
#### Fork disclaimer
|
||||||
|
|
||||||
This theme is a fork (not a port) of "Terminal" Hugo theme
|
This theme is a fork (not a port) of "Terminal" Hugo theme
|
||||||
|
@ -23,6 +25,37 @@ Many thanks for that outstanding original theme, Radek!
|
||||||
For more information about this fork and the differences to the original theme, please see:
|
For more information about this fork and the differences to the original theme, please see:
|
||||||
[Changes compared to the original theme](#changes-compared-to-the-original-theme) below.
|
[Changes compared to the original theme](#changes-compared-to-the-original-theme) below.
|
||||||
|
|
||||||
|
<!-- omit from toc -->
|
||||||
|
## Table of contents
|
||||||
|
|
||||||
|
- [Versioning](#versioning)
|
||||||
|
- [How to start](#how-to-start)
|
||||||
|
- [Shortcodes](#shortcodes)
|
||||||
|
- [`image`](#image)
|
||||||
|
- [`figure`](#figure)
|
||||||
|
- [Features](#features)
|
||||||
|
- [OpenGraph](#opengraph)
|
||||||
|
- [Mastodon](#mastodon)
|
||||||
|
- [Configuration](#configuration)
|
||||||
|
- [Only show the post's description](#only-show-the-posts-description)
|
||||||
|
- [Colors](#colors)
|
||||||
|
- [Logo text and link](#logo-text-and-link)
|
||||||
|
- [Author and copyright](#author-and-copyright)
|
||||||
|
- [Menu](#menu)
|
||||||
|
- [Tags](#tags)
|
||||||
|
- [Pagination](#pagination)
|
||||||
|
- [Language code](#language-code)
|
||||||
|
- [Hack font subset](#hack-font-subset)
|
||||||
|
- [Favicon](#favicon)
|
||||||
|
- [Page titles](#page-titles)
|
||||||
|
- [Extending](#extending)
|
||||||
|
- [How to contribute](#how-to-contribute)
|
||||||
|
- [Changes compared to the original theme](#changes-compared-to-the-original-theme)
|
||||||
|
- [New features](#new-features)
|
||||||
|
- [Features retained from the original](#features-retained-from-the-original)
|
||||||
|
- [License](#license)
|
||||||
|
|
||||||
|
|
||||||
## Versioning
|
## Versioning
|
||||||
|
|
||||||
This theme used to be non-versioned, e.g. you'd pull the master branch, and occasionally new features or fixes would
|
This theme used to be non-versioned, e.g. you'd pull the master branch, and occasionally new features or fixes would
|
||||||
|
@ -103,7 +136,9 @@ Example:
|
||||||
caption_style="font-style: italic;") }}
|
caption_style="font-style: italic;") }}
|
||||||
```
|
```
|
||||||
|
|
||||||
## OpenGraph
|
## Features
|
||||||
|
|
||||||
|
### OpenGraph
|
||||||
|
|
||||||
To add an image to a post, set the `og_image` extra option to the desired image
|
To add an image to a post, set the `og_image` extra option to the desired image
|
||||||
in the same directory of the markdown file:
|
in the same directory of the markdown file:
|
||||||
|
@ -121,6 +156,16 @@ Additionally, for the section pages and for posts to have a fallback image, add
|
||||||
default_og_image = "static/ocean.jpg"
|
default_og_image = "static/ocean.jpg"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Mastodon
|
||||||
|
|
||||||
|
To enable [Mastodon verification](https://docs.joinmastodon.org/user/profile/#verification), add
|
||||||
|
the following to your `config.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
mastodon_url = "https://hachyderm.io/@opeik"
|
||||||
|
```
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
### Only show the post's description
|
### Only show the post's description
|
||||||
|
@ -428,3 +473,5 @@ for more information.
|
||||||
|
|
||||||
The license for Hack fonts used is included in
|
The license for Hack fonts used is included in
|
||||||
[LICENSE-Hack.md](../master/LICENSE-Hack.md).
|
[LICENSE-Hack.md](../master/LICENSE-Hack.md).
|
||||||
|
|
||||||
|
[utterances]: https://utteranc.es/
|
||||||
|
|
|
@ -30,6 +30,10 @@
|
||||||
<link rel="shortcut icon" type="{{ config.extra.favicon_mimetype | default(value="image/x-icon") | safe }}" href="{{ config.extra.favicon | safe }}">
|
<link rel="shortcut icon" type="{{ config.extra.favicon_mimetype | default(value="image/x-icon") | safe }}" href="{{ config.extra.favicon | safe }}">
|
||||||
{% endif -%}
|
{% endif -%}
|
||||||
|
|
||||||
|
{%- if config.extra.mastodon_url %}
|
||||||
|
{%- block mastodon %}{{ head_macros::mastodon(config=config) }}{% endblock mastodon -%}
|
||||||
|
{% endif -%}
|
||||||
|
|
||||||
{%- block extra_head %}
|
{%- block extra_head %}
|
||||||
{% endblock extra_head -%}
|
{% endblock extra_head -%}
|
||||||
</head>
|
</head>
|
||||||
|
|
|
@ -92,3 +92,7 @@
|
||||||
<meta property="twitter:domain" content="{{ config.base_url | replace(from="https://", to="") }}">
|
<meta property="twitter:domain" content="{{ config.base_url | replace(from="https://", to="") }}">
|
||||||
<meta property="twitter:url" content="{{ permalink | safe }}">
|
<meta property="twitter:url" content="{{ permalink | safe }}">
|
||||||
{% endmacro open_graph %}
|
{% endmacro open_graph %}
|
||||||
|
|
||||||
|
{% macro mastodon(config) %}
|
||||||
|
<link rel="me" href="{{ config.extra.mastodon_url }}" />
|
||||||
|
{% endmacro mastodon %}
|
||||||
|
|
Loading…
Reference in a new issue