Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/forestryio/novela-hugo-starter

Novela, the simplest way to start publishing with Hugo and Forestry.
https://github.com/forestryio/novela-hugo-starter

blog-theme forestry-cms forestry-starter hugo-starter

Last synced: about 1 month ago
JSON representation

Novela, the simplest way to start publishing with Hugo and Forestry.

Awesome Lists containing this project

README

        

[![Netlify Status](https://api.netlify.com/api/v1/badges/8fd7da5f-0c4d-4a43-9e23-2d1baf0d35cc/deploy-status)](https://app.netlify.com/sites/hugo-novela-forestry/deploys)

# Hugo Novela Forestry Starter

A port of [Narative](https://www.narative.co/)'s Gatsby theme [Novela](https://www.narative.co/labs/novela/)

![](images/tn.png)


Import this project into Forestry

## Prerequisites

This starter is importing the theme as a [Hugo Module](https://gohugo.io/hugo-modules/)

- Go > 1.12
- Hugo > 0.65.0

## Content Management

![Forestry user interface](images/novela-forestry.png)

This starter is ready to be imported into [Forestry](https://forestry.io) ✨.

Any changes you save in the CMS will be commited back to your Git repository.

## Deploy on Netlify

Import your repository in [Netlify](https://netlify.com)

1. Create a new site in Netlify and import your repository.
2. Set the build command to: `hugo --gc --minify`
3. Set the publish directory to: `public`
4. Set `GO_VERSION` to `1.12` or above
4. Set `HUGO_VERSION` to `0.65.3` or above

That's it, now your site gets deployed automatically on `git push` or when saving documents from Forestry.

## Deploy on Vercel

Import your repository in [Vercel](https://vercel.com/new/git/third-party)

[Add a bash script](https://gist.github.com/DirtyF/4f89704ecd619c0dcd439d74115da542#file-hugo_build-sh) and [build steps via a `vercel.json` file](https://gist.github.com/DirtyF/4f89704ecd619c0dcd439d74115da542#file-vercel-json) in your repository in order to build the site.

## Development

```bash
# clone your repository
# cd in your project directory
# Start local server
hugo server
```

For more information, see [official Hugo documentation](https://gohugo.io/getting-started/).

## Customization

### Logo

Add to your projects layout directory your logo's SVG:
`/layouts/icons/ui/logo.html`

### 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

Add a similar file to your content directory and Front Matter example.

```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: github
url: https://github.com
- title: twitter
url: https://twitter.com
- title: instagram
url: https://instagram.com
- title: dribbble
url: https://dribbble.com
- title: unsplash
url: https://unsplash.com
---
```

#### Assigning authors to posts.

Add the name of the author to the "authors" field:

```yaml
authors:
- Dennis Brotzky
- Thiago Costa
```
### Newsletter call to action

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="[email protected]" >}}
```

## LICENSE

MIT