search

doctavious / doctavious-cli

0 stars 0 forks source link

Add Metadata to Templates #2

Open seancarroll opened 4 years ago

seancarroll commented 4 years ago

Add metadata aka Front Matter to template files See https://github.com/trentm/python-markdown2/wiki/metadata

RFC Examples

Joyent

---
authors: 
state: prediscussion
discussion: https://github.com/joyent/rfd/issues?q="RFD+169"
---

CouchDB

---
name: Formal RFC
about: Submit a formal Request For Comments for consideration by the team.
title: 'Replicator Implementation On FDB'
labels: rfc, discussion
assignees: 'vatamane@apache.org'
---

For ADR frontmatter metadata doesnt appear to be commonly used.

seancarroll commented 3 years ago

One other thing to be cautious of is that front matter is not part of the CommonMark spec. As a result we will need to be careful what Markdown parser we use as Doctavious might have to extract it from the document before passing content to parser.