diff --git a/README.md b/README.md index 2053460..3eeb6d5 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ + # 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) @@ -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. + #### Fork disclaimer 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: [Changes compared to the original theme](#changes-compared-to-the-original-theme) below. + +## 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 This theme used to be non-versioned, e.g. you'd pull the master branch, and occasionally new features or fixes would @@ -130,7 +163,7 @@ the following to your `config.toml`: ```toml [extra] -mastodon_url = "https://hachyderm.io/@my_username_here" +mastodon_url = "https://hachyderm.io/@opeik" ``` ## Configuration @@ -440,3 +473,5 @@ for more information. The license for Hack fonts used is included in [LICENSE-Hack.md](../master/LICENSE-Hack.md). + +[utterances]: https://utteranc.es/