FrontMeta
FrontMeta is a minimalist front-matter format that uses key:value
pairs rather than YAML. This results in a parser that is optimized for both size and speed.
Features
- ECMAScript Module
- CommonJS Bundle Included
- Typescript Compatible
Installation
npm install frontmeta
;
Usage
Parse and stringify FrontMeta
FrontMeta.parse()
FrontMeta.parse(frontmeta) : object
- contents - a string representing the document contents
Example
frontmeta
---
key1:value1
key2:value2
---
This is the document body.
;const frontmeta = // the document frontmetaconst parsed = FrontMetaconsole;> > "meta": > "key1": "value1"> "key2": "value2"> > "body": "This is the document body.">
FrontMeta.parse()
FrontMeta.stringify(document) : object
- document - The frontmeta document object
- meta - the frontmeta
key:value
data - body - the document body
- meta - the frontmeta
document
;const document = // the frontmeta document objectconst parsed = FrontMetaconsole;> ---> key1:value1> key2:value2> ---> This is the document body
CommonJS
A .cjs
bundle is included for CommonJS compatibility
FrontMeta.parse()
const FrontMeta = ;const frontmeta = // the document frontmetaconst data = FrontMeta;
FrontMeta.stringify()
const FrontMeta = ;const document = // the frontmeta document objectconst data = FrontMeta;
Typings
Typings are generated from JSDoc using Typescript. They are 100% compatible with VSCode Intellisense and will work seamlessly with Typescript.