main
commit
ab24565e76
|
@ -0,0 +1,25 @@
|
||||||
|
# frontmatter.rec
|
||||||
|
|
||||||
|
minimal acceptable document metadata
|
||||||
|
schema and scaffolding
|
||||||
|
|
||||||
|
## usage
|
||||||
|
|
||||||
|
```sh
|
||||||
|
❯ printf "%s\n" "---" $(recsel frontmatter.rec | recfmt '{{title}}:
|
||||||
|
') "---" > document.md
|
||||||
|
|
||||||
|
❯ cat document.md
|
||||||
|
|
||||||
|
---
|
||||||
|
title:
|
||||||
|
description:
|
||||||
|
author:
|
||||||
|
version:
|
||||||
|
created:
|
||||||
|
published:
|
||||||
|
updated:
|
||||||
|
flags:
|
||||||
|
tags:
|
||||||
|
---
|
||||||
|
```
|
|
@ -0,0 +1,44 @@
|
||||||
|
%rec: frontmatter
|
||||||
|
%doc: minimal acceptable document metadata
|
||||||
|
%mandatory: title type description
|
||||||
|
%allowed: title type description
|
||||||
|
%type: title,description line
|
||||||
|
%type: type enum string datetime list
|
||||||
|
%key: title
|
||||||
|
|
||||||
|
title: title
|
||||||
|
type: string
|
||||||
|
description: the title of the document
|
||||||
|
|
||||||
|
title: description
|
||||||
|
type: string
|
||||||
|
description: a summary, description, or tagline of the document
|
||||||
|
|
||||||
|
title: author
|
||||||
|
type: string
|
||||||
|
description: the author of the document
|
||||||
|
|
||||||
|
title: version
|
||||||
|
type: string
|
||||||
|
description: document version
|
||||||
|
|
||||||
|
title: created
|
||||||
|
type: datetime
|
||||||
|
description: when did work begin on the document
|
||||||
|
|
||||||
|
title: published
|
||||||
|
type: datetime
|
||||||
|
description: when was the document originally published
|
||||||
|
|
||||||
|
title: updated
|
||||||
|
type: datetime
|
||||||
|
description: when was the document last updated
|
||||||
|
|
||||||
|
title: flags
|
||||||
|
type: list
|
||||||
|
description: document status e.g. hidden, draft, unlisted
|
||||||
|
|
||||||
|
title: tags
|
||||||
|
type: list
|
||||||
|
description: keywoards, categories, and tags
|
||||||
|
|
Loading…
Reference in New Issue