I've decided that a simple metadata parser would be useful in markdown documents.

The syntax is:

--- or ««« at the beginning of the markdown document
optionally followed by a alphanumeric designation of the format (anything you like as long as it does not have any white spaces or newlines and stuff)
followed by a newline
followed by key value pairs separated by a colon and a space : and a newline at the end
Closed by --- or »»» and a newline

like this:

---
title: document title
some meta name: some meta content
---
# my markdown document

rest of the document

«««
title: document title
some meta name: some meta content
»»»
# my markdown document

rest of the document

or even this:

---FORMAT-IDENTIFIER
title: document title
some meta name:
 - a list
 - of values
---
# my markdown document

rest of the document

To enable metadata parsing, one must enable the option metadata.

var conv = new showdown.Converter({metadata: true});

Showdown will expose a method for retrieving the document's metadata after parsing:

var conv = new showdown.Converter({metadata: true});
var html = conv.makeHtml(someMd);
var metadata = conv.getMetadata(); // returns an object with the document metadata

Note that showdown won't support YAML (or any other data format) out of the box, but you can retrieve the raw metadata and parse it yourself.

var conv = new showdown.Converter({metadata: true});
var html = conv.makeHtml(someMd);
var metadata = conv.getMetadata(true); // returns a string with the raw metadata
var metadataFormat = conv.getMetadataFormat(); // returns the format of the metadata

// do stuff with the metadata var

How to save/get metadata? #260

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions