FFF

Appearance

FFF Flavored Frontmatter
Version 0.1 ​

Published: 2022-07-18

The first version of FFF Flavored Frontmatter, inherited most of the variables from Urara.

Base ​

Base variables: It has been implemented for some time and is more commonly used.

title ​

  • type: string
  • jsonfeed: title
  • microformats: p-name
  • description: The title of the post.
yaml
title: 'Title'

summary ​

  • type: string
  • jsonfeed: summary
  • microformats: p-summary
  • description: summary[1] conveys the main point of the post.
yaml
summary: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'

created ​

  • type: string
  • description: The created[2] date of the post, in any string - specified by the corresponding implementation.
yaml
created: 2022-07-18

updated ​

  • type: string
  • jsonfeed: date_modified
  • microformats: dt-updated
  • description: The updated[3] date of the post, in any string - specified by the corresponding implementation.
yaml
updated: 2022-07-18

published ​

  • type: string
  • jsonfeed: date_published
  • microformats: dt-published
  • description: The published[4] date of the post, in any string - specified by the corresponding implementation.
yaml
updated: 2022-07-18

photo ​

  • type: string
  • optional type: string[]
  • jsonfeed: image (string only)
  • microformats: u-photo[5] or u-featured[6]
  • description: Link to an image, also support multi-photo[7].
yaml
photo: '/images/foo.avif'
# or
photo:
- '/images/foo.avif'
- '/images/bar.avif'

alt ​

  • type: string
  • optional type: string[]
  • description: Optional image alternative, also available as figcaption.
yaml
photo: '/images/foo.avif'
alt: 'lorem ipsum'
# or
photo:
- '/images/foo.avif'
- '/images/bar.avif'
alt:
- 'lorem'
- 'ipsum'

tags ​

  • type: string[]
  • jsonfeed: tags
  • microformats: u-category
  • description: Tags are provided in array. also as an alternative to categories.
yaml
tags:
  - foo
  - bar

flags ​

  • type: string[]
  • description: Array of strings, inspired by browser://flags, available values are determined by the specific implementation.
yaml
flags:
  - unlisted # https://indieweb.org/unlisted
  - draft

Extra ​

Extra variables: This means that its naming is tentative and only used as a suggestion if needed.

audio ​

  • type: string
  • microformats: u-audio[8]
  • description: Link to an audio file.
yaml
audio: '/podcast.flac'

video ​

  • type: string
  • microformats: u-video[9] or u-featured[6:1]
  • description: Link to an video file.
yaml
video: '/video.av1'

bookmark_of ​

  • type: string
  • microformats: u-bookmark-of
  • description: URL of specify the bookmark[10].
yaml
bookmark_of: 'https://example.com/permalink47'

like_of ​

  • type: string
  • microformats: u-like-of
  • description: URL of specify the like[11].
yaml
like_of: 'https://example.com/permalink47'

repost_of ​

  • type: string
  • microformats: u-repost-of
  • description: For re-posting[12] other posts.
yaml
repost_of: 'https://example.com/permalink47'

in_reply_to ​

  • type: string
  • optional type: string[]
  • microformats: u-in-reply-to[13]
  • description: For replying[14] or multi-replying[15] to other posts.
yaml
in_reply_to: 'https://example.com/post123'
# or
in_reply_to:
- 'https://example.com/post123'
- 'https://example.com/post456'

syndication ​

  • type: string | string[]
  • microformats: u-syndication[16]
  • description: URL(s) of syndicated copies of this post.
yaml
syndication: 'https://twitter.com/example/status/1542566710594658312'
# or
syndication:
- 'https://twitter.com/example/status/1542566710594658312'
- 'https://mastodon.social/@example/108964809799826911'

Type ​

A TypeScript type with type hints.

ts
/**
 * FFF Flavored Frontmatter
 * Version 0.1.0
 */
type FFFFlavoredFrontmatter = {
  title?: string
  summary?: string
  created?: string
  updated?: string
  published?: string
  photo?: string | string[]
  alt?: string | string[]
  tags?: string[]
  flags?: string[]
  audio?: string
  video?: string
  bookmark_of?: string
  like_of?: string
  repost_of?: string
  in_reply_to?: string | string[]
  syndication?: string | string[]
}

References ​

  1. summary - IndieWeb ↩︎

  2. created - IndieWeb ↩︎

  3. updated - IndieWeb ↩︎

  4. published - IndieWeb ↩︎

  5. photo - IndieWeb ↩︎

  6. featured - IndieWeb ↩︎ ↩︎

  7. multi-photo - IndieWeb ↩︎

  8. audio - IndieWeb ↩︎

  9. video - IndieWeb ↩︎

  10. bookmark - IndieWeb ↩︎

  11. like - IndieWeb ↩︎

  12. repost - IndieWeb ↩︎

  13. in-reply-to - IndieWeb ↩︎

  14. reply - IndieWeb ↩︎

  15. multiple-reply - IndieWeb ↩︎

  16. u-syndication - IndieWeb ↩︎