blob: 72af30598c0b8ed71f51c6ac3467b89f2c7d9d65 (
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
# Hugo Novela
A port of [Narative](https://www.narative.co/)'s Gatsby theme [Novela](https://www.narative.co/labs/novela/)
**This theme requires Hugo extended > 0.65.0**
The easiest way to get started is to [import this theme in Forestry CMS](https://app.forestry.io/quick-start?repo=forestryio/novela-hugo-starter&engine=hugo&version=0.81.0) in a single click
<a href="https://app.forestry.io/quick-start?repo=forestryio/novela-hugo-starter&engine=hugo&version=0.81.0">
<img alt="Import this project into Forestry" src="https://assets.forestry.io/import-to-forestryK.svg" />
</a>
## Install from the command line
If you don't want to use the [starter](https://github.com/forestryio/novela-hugo-starter), you can start from scratch and just install this theme from the command line.
Create a new Hugo site and initialize your project as a [Hugo module](https://gohugo.io/hugo-modules/use-modules/):
```
hugo new site my-awesome-blog
cd my-awesome-blog
hugo mod init
```
Edit your `config.toml` to add the theme settings:
```toml
# Novela settings
theme = "github.com/forestryio/hugo-theme-novela"
paginate = 6
[social]
twitter= "https://twitter.com/forestryio"
github= "https://github.com/forestryio/novela-hugo-starter"
linkedin= "https://www.linkedin.com/company/forestry.io"
instagram = "#"
dribbble = "#"
youtube = "#"
[taxonomies]
author = "authors"
```
Create your first draft post and preview it locally:
```
hugo new post/my-first-post.md
hugo server -D
```
You're good to go!
## Customization
### Logo
Override `/themes/novela/layouts/partials/icons/ui/logo.html` with your own file at `/layouts/partials/icons/ui/logo.html`; include your logo in SVG format for desktop and mobile formats.
Novela supports light and dark mode. To have your logo respond in kind, add `class="change-fill"` to the svg path(s).
### Socials
In order for the Socials to be surfaced in Forestry, you should copy the theme's `config/_default/social.yaml` to your project.
### Authors
You should register authors as a taxonomy in your project's `config.yaml``
```yaml
taxonomies:
author: authors
```
#### Creating authors
Authors must be added in `content/authors`.
Create a folder per author and add an `_index.md` file in it.
Here's an example of the front matter fields supported by default:
```yaml
# /content/authors/firstname-lastname/_index.md
---
title: Dennis Brotzky
bio: |
Written by You. This is where your author bio lives. Share your work, your
joys and of course, your Twitter handle.
avatar: /images/dennis-brotzky.jpg
featured: true
social:
- title: unsplash
url: https://unsplash.com
- title: github
url: https://github.com
- title: github
url: https://github.com
- title: github
url: https://github.com
- title: github
url: https://github.com
---
```
#### Assigning authors to posts.
Ad the name of the author to the "authors" field:
```yaml
authors:
- Dennis Brotzky
- Thiago Costa
```
### Newsletter CTA
This theme includes a shortcode for a newsletter callout form that you can add to any page.
It uses [formspree.io](//formspree.io/) as proxy to send the actual email. Each month, visitors can send you up to one thousand emails without incurring extra charges. Visit the Formspree site to get get going add your Formspree email to your shortcode like this:
```
{{< subscribe email="your@email.com" >}}
```
|
