hugo-typo/README.md
2024-06-09 14:52:05 +02:00

56 lines
No EOL
1.9 KiB
Markdown

![banner](https://raw.githubusercontent.com/tomfran/typo/main/images/banner-light.png)
# Typo, a Hugo theme.
Typo is a theme backed by simplicity, as you can see in the screenshots below. The goal was to have a website centered around content and nothing more.
[![wiki](https://img.shields.io/badge/doc-wiki-orange)](https://github.com/tomfran/typo/wiki)
[![hugo-typo](https://img.shields.io/badge/hugo_themes-@typo-red)](https://themes.gohugo.io/themes/typo/)
[![GitHub Release](https://img.shields.io/github/v/release/tomfran/typo)](https://github.com/tomfran/typo/releases/latest)
[![last-commit](https://img.shields.io/github/last-commit/tomfran/typo)](https://github.com/tomfran/typo/commits/)
**Homepage**
![1](https://raw.githubusercontent.com/tomfran/typo/main/images/1.png)
**Article**
![2](https://raw.githubusercontent.com/tomfran/typo/main/images/2.png)
![3](https://raw.githubusercontent.com/tomfran/typo/main/images/3.png)
---
**Table of content**
- [1 Setup](#1-setup)
- [2 Features](#2-features)
- [3 References](#3-references)
- [4 Support](#4-support)
---
## 1 Setup
You can install Typo in various ways, the [setup wiki](https://github.com/tomfran/typo/wiki/Setup) page highlights how to do so.
## 2 Features
The theme has various features, such as header auto-numbering, auto dark mode, color palettes, and dark and light images.
Have a look at the [wiki](https://github.com/tomfran/typo/wiki/Features) for a complete overview of the available ones.
## 3 References
The SVGs for social icons are taken from [Hugo PaperMod](https://github.com/adityatelange/hugo-PaperMod).
## 4 Support
If you use the theme or found it useful you can support me by leaving a star ⭐ to Typo's Github repository or opening issues and PRs with fixes or new features.
---
**Things to work on**
- Footer on Safari is slightly bugged, and is placed too far down the page;
- Performance improvement on post pages.