summaryrefslogtreecommitdiff
path: root/README.md
blob: 7e82c926ad83b3c6015c1e9c67603196a967ff05 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
![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.