typo/README.md
2024-04-22 14:16:31 +02:00

92 lines
1.4 KiB
Markdown

![banner](misc/readme.png)
# Typo, a Hugo theme.
**Homepage**
![1](misc/1.png)
**Article**
![1](misc/2.png)
![1](misc/3.png)
## Installation
To receive updates, add the theme as a submodule:
```
git submodule add git@github.com:tomfran/typo.git themes/typo
```
Otherwise you can clone the repo and copy it manually to yout theme folder.
## Configuration example
Here is an example configuration:
```toml
baseURL = 'https://example.org/'
languageCode = 'en-us'
disableKinds = ['taxonomy']
title = 'Title'
theme = 'Typo'
googleAnalytics = "G-XXXXXXXXX"
[params]
# Math mode
math = true
# Intro on main page, content in markdown
homeIntro = true
homeIntroTitle = 'Hi!'
homeIntroContent = """
Here is my blog, this supports markdown:
- a
- b
- c
"""
# Collection to display on home
homeCollectionTitle = 'Posts'
homeCollection = 'posts'
# Pagination size across all website
paginationSize = 100
# Social icons
[[params.social]]
name = "linkedin"
url = "https://www.linkedin.com/in/"
[[params.social]]
name = "medium"
url = "https://medium.com/"
[[params.social]]
name = "github"
url = "https://github.com/"
# Main menu pages
[[params.menu]]
name = "home"
url = "/"
[[params.menu]]
name = "posts"
url = "/posts"
[[params.menu]]
name = "about"
url = "/about"
# Syntax highligth on code blocks
[markup]
[markup.highlight]
style = 'algol'
```
Tags are intentionally omitted.