Installation
Below are the ways to get started with the Typo theme.
Getting Started
First of all, create a new Hugo project as follows:
hugo new site <your site name> --config toml
Downloading the Theme
Themes are contained in the /themes
directory, there are different ways to get Typo there
Submodule - Recommended
git submodule add --depth=1 https://git.push-f.com/tastefejl themes/tastefejl
git submodule update --init --recursive
Hugo module
Installing Typo as a Hugo module requires Go to be installed in your development environment.
# Initialize your project as a Hugo module
hugo mod init <module_name>
# Install the theme
hugo mod get github.com/tomfran/typo
Then add the following to hugo.toml
:
[module]
[[module.imports]]
path = "github.com/tomfran/typo"
Finally, remove the theme = 'typo'
parameter from hugo.toml
.
Sample Config
Use those to get started with the theme. You can find a complete overview of the available features here.
Here you can find a repo using this theme.
Site Config
Here is a sample hugo.toml
config to get started with the theme.
baseURL = 'https://example.org/'
languageCode = 'en-us'
title = 'My website'
theme = 'tastefejl'
# Google analytics code
googleAnalytics = "G-xxxxxxxxx"
[taxonomies]
tag = 'tags'
[params]
# Meta description
description = "A Tech Blog"
# Appearance settings
theme = 'auto'
colorPalette = 'default'
hideHeader = false
# Collection to display on home
homeCollectionTitle = 'Posts'
homeCollection = 'posts'
# Lists parameters
paginationSize = 100
listSummaries = true
listDateFormat = '2 Jan 2006'
# Breadcrumbs
[params.breadcrumbs]
enabled = true
showCurrentPage = true
home = "Home"
# Main menu pages
[[params.menu]]
name = "home"
url = "/"
[[params.menu]]
name = "posts"
url = "/posts"
[[params.menu]]
name = "about"
url = "/about"
# Syntax highlight on code blocks
[markup]
[markup.highlight]
style = 'algol'
# Giscus comments
[params.giscus]
enable = false
repo = "user/repo"
repoid = "repoId"
category = "General"
categoryid = "categoryId"
mapping = "pathname"
theme = "preferred_color_scheme"
Post Config
Sample post config.
---
title: "Log-Structured Merge Tree"
author: "Francesco"
authorAvatarPath: "/avatar.jpeg"
date: "2023-11-12"
summary: "An LSM Tree overview and Java implementation."
description: "An LSM Tree overview and Java implementation."
toc: true
readTime: true
autonumber: true
math: true
tags: ["database", "java"]
showTags: false
hideBackToTop: false
fediverse: "@username@instance.url"
---
Support
If you use the theme or found it useful you can support me by leaving a star :star: to Typo’s Github repository or opening issues and PRs with fixes or new features.