Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/thegeeklab/hugo-geekblog.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Kaussow <mail@thegeeklab.de>2021-06-07 19:38:11 +0300
committerRobert Kaussow <mail@thegeeklab.de>2021-06-07 19:38:11 +0300
commit36f8fe83b25d951f217f1b1bb19f5a6992170993 (patch)
tree37590a0e10df5d67e4d40184a776347bfb155213 /exampleSite
parent9773442a7b9336a6bcdf1f6755d9969811dc2b31 (diff)
docs: add information how to use authorsv0.10.2
Diffstat (limited to 'exampleSite')
-rw-r--r--exampleSite/content/posts/getting-started.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/exampleSite/content/posts/getting-started.md b/exampleSite/content/posts/getting-started.md
index 1432921..35b5d76 100644
--- a/exampleSite/content/posts/getting-started.md
+++ b/exampleSite/content/posts/getting-started.md
@@ -3,6 +3,7 @@ title: Getting Started
date: 2020-07-15T20:00:00+02:00
authors:
- john-doe
+ - Special User
tags:
- Documentation
weight: 1
@@ -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: john@example.com
+```
+
+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