Logg for Aslak Raanes

Metadata for markdown

Skrevet av

Aslak Raanes

i

Det kan være nyttig å plassere metadata for tittel, forfatter, dato o.l. utenfor selve teksten i et Markdown-dokument. En løsning på det er å definere at begynnelsen på dokumentet kan innholde metadata.

Metadata kan for eksempel plasseres i en YAML-blokk; hvor --- definerer start, og --- eller ... definerer slutten på YAML frontmatter.

---
title: Lurium ipsum!
subject: Lurium laruim ipsum
date: 2024-06-26
keywords: 
  - hopp
  - hepp
  - hipp
author: Aslak
---
Code language: YAML (yaml)

som Github presenter omtrent slik:

Skjermbilde at Github sin presentasjon av en YAML-frontmatter. Denne inneholder title, date, author, keywords osv.
Github sin presentasjon av en YAML-frontmatter.

Men er egentlig YAML noe ok til slikt?

En annen variant er å bruke MultiMarkdown (MMD) sine metadata-felt som ligner på epost/netnews (RFC 5322 og RFC 5536 ) og andre internet metadata-felt:

Title: Lurium ipsum!
Subject: Lurium laruim ipsum
Date: 2024-06-26
Keywords: hopp, hepp, hipp
Author: Aslak
Code language: HTTP (http)

Navn på metadata angis som en kort tekst som avsluttes med : og resten linjene som tekst med selve metadata. Metadatablokken avsluttes med to (en?) tomme linjer.

Som med overnevnte RFC-er og RFC 9651 (Structured Field Values for HTTP) så burde lister kunne angis som:

Keywords: hopp
Keywords: hepp, hipp
Code language: HTTP (http)

Det tror jeg ikke alle implementasjoner av MMD, om noen, støtter.

Flere innlegg