Skip to content

Commit

Permalink
docs: add information how to use authors
Browse files Browse the repository at this point in the history
  • Loading branch information
xoxys committed Jun 7, 2021
1 parent 9773442 commit 36f8fe8
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions exampleSite/content/posts/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Getting Started
date: 2020-07-15T20:00:00+02:00
authors:
- john-doe
- Special User
tags:
- Documentation
weight: 1
Expand Down Expand Up @@ -511,6 +512,38 @@ The theme bundles just a small set of hand crafted icons.

{{< sprites >}}

## Setup Authors

The theme supports multiple authors. The required information for each author need to be stored in a single [Hugo data template](https://gohugo.io/templates/data-templates/) per author. These files need to be stored in the `data/authors/` directory in your projects root:

```Shell
data/
└── authors
├── john-doe.yml
├── richard-roe.yml
└── Special User.yml
```

The name of the file will be used as the reference later, so if you prefer some kind of naming convention this need to covered by the file names. Example authors file:

```YAML
name: John Doe
email: [email protected]
```

With the defined files, you can add as many authors as you want to the front matter of your posts:

```Markdown
---
title: Demo Posts
authors:
- john-doe
- Special User
---
My first demo post.
```

## Known Limitations

### Minify HTML results in spacing issues
Expand Down

0 comments on commit 36f8fe8

Please sign in to comment.