caffeinated.blog/content/post/author-bios.md

58 lines
2.0 KiB
Markdown
Raw Normal View History

2019-10-26 00:09:08 +10:00
---
title: "Author Bios"
date: 2018-10-01T08:00:00-04:00
draft: false
categories: ["meta"]
tags: ["options"]
---
The bottom of every page in the theme can optionally show a short biography of the site author, including a profile picture, email link, and location.
<!--more-->
## Setting up the author bio
A set of configuration options are used for displaying the biography.
```
[params]
Author = "Author Name"
Avatar = "images/site-logo.svg"
Biography = "A short description, a few sentences describing the author. Set
the 'ShowBio' parameter to false to hide this."
ShowBio = true
[params.indieWeb]
EmailAddress = "email.address@example.com"
Country = "CountryName"
City = "CityName"
```
Specifics on each setting item are as follows:
- `Author`: Your name; this is the site author name.
- `Avatar`: The path to your profile picture. By default, it will show the theme's logo (`/static/images/site-logo.svg`).
- `Biography`: Hopefully the placeholder text here is self-explanatory; add a couple of short sentences about yourself here.
- `ShowBio`: If you prefer not to show the author bio, set this to `false`. By default, it's set to `true`.
- `EmailAddress`: The email address at which you can be contacted.
- `Country`: The name of the country in which you live.
- `City`: The name of the city in which you live.
## IndieWeb features
The following classes are used to mark up the author bio for [IndieWeb][indieweb] parsing:
| Element | Class |
| :-------------- | :-------------------------- |
| The author card | `h-card` |
| Profile picture | `u-photo` |
| Author URL* | `p-name`, `u-url`, `rel=me` |
| City | `p-locality` |
| Country | `p-country-name` |
| Email address | `u-email` |
| Biography | `p-note` |
*Author URL is set to the site's base URL.
[indieweb]: https://indieweb.org