awoo-matter
A front matter parsing plugin for the awoo static site generator
Features
- Extract YAML metadata (Front Matter) from text files within the awoo
files
array - Custom filter functions to include or exclude files from transforms
Installation
npm install --save awoo-matter
Usage example
const awoo = const matter = // enter our main function:// the main function should be an async function so that// it automatically returns a promise
Filter example
You can pass a custom filter as an option to matter
to include or exclude files.
A filter is a function that takes the arguments file
, options
, and files
. file
is the current file, options
is the options object passed to matter
, and files
is the entire array of files created by awoo
.
When the filter function returns true
, matter
applies its transforms to the current file
object. Otherwise the file
object remains unchanged.
The default filter in matter
always returns true, so the transform will be applied to every file:
{ return true}
This is how you could use a filter to only apply matter
to files ending with .md
:
const awoo = const matter = // custom filter function// returns true if file path ends with '.md' { return filepath}
Options Example
matter
uses [gray-matter](http://npm.im/gray-matter)
for parsing metadata. All options of gray-matter
are also available in matter
.
This is what a plugin call with custom options would look like:
const awoo = const matter = // we define our options object...const myMatterOptions = delims: '~~~'
How does it work?
matter
extracts any Front Matter from the contents
property of a file
object and writes it to its metadata
property.
Given the following text file:
---
title: Greeting
---
Hello World
The resulting awoo file
object would be:
contents: 'Hello World'metadata: title: 'Greeting'
Maintainers
- Frederic Marx <marx.frederic@gmail.com>
Code of Conduct
This repository operates under the weallbehave
Code of Conduct. Its contents can be found in CODE_OF_CONDUCT.md
.
License
MIT (see LICENSE document)