Skip to content

Author files

Frederick O'Brien edited this page Mar 23, 2021 · 3 revisions

Author files are currently simple, they contain a required name property, a forename property, and an optional set of links. The name property is the author's full name. The forename property is their, erm, forename.

Author links

An author can have any number of links attached to them but each set of links must set a default. The default is what will be linked to on author bylines. default: twitter would link the author's name to their Twitter account, for example.

Other links may be displayed in more in-depth contexts such as author pages in the future. Below are common examples which we can present all fancy like:

  • twitter
  • facebook
  • instagram
  • email

All other links will be treated as plain URLs, although specifying website will do. Because a key-value structure is currently used, multiple special links are not supported. Multiple plain URLs may be specified provided the keys are different.

Example
---
name: John Doe                      # This will be used as a display name for this author
forename: John                      # This will be used to head individual summaries on album reviews
links:                              # A key-value store of links attached to this author
  twitter: sometwitterhandle        # Note that the @ character should NOT be included
  facebook: somefacebookhandle
  instagram: someinstagramhandle
  github: somegithubhandle
  email: user@example.com           # Note that mailto: should NOT be included
  website: https://www.example.com  # Note the full URL, including "https://" is included
  default: twitter                  # Relates to a key specified above; used under author names in posts

Authors must have a GitHub link to be able to use the content dropbox.

Clone this wiki locally