options

All methods will accept an options object to be passed as a second parameter

options.eval

Type: Boolean

Default: false

Evaluate coffee-script, CSON or JavaScript in front-matter. If you aren't aware of the dangers, google is your friend.

options.lang

Type: String

Default: yaml

The parser to use on the extracted front matter. Valid options include:

• yaml

• json

• coffee

• cson

• toml

• js|javascript

options.delims

Type: Object

Default: {delims: ['---', '---']}

Open and close delimiters can be passed in as an array of strings. Example:

matter.read('file.md', {delims: ['~~~', '~~~']});

You may also pass an array of arrays, allowing multiple alternate delimiters to be used. Example:

{
  delims: [
    ['---', '~~~'], ['---', '~~~']
  ]
}

Note that passing multiple delimiters will yield unpredictable results, it is recommended that you use this option only for testing purposes.

options.autodetect

Type: Boolean

Default: undefined

Attempts to automatically register a language that is specified after the first code boundary (delimiter).

Usage Example:

--- coffee
user = 'jonschlinkert'
reverse = (src) ->
  src.split('').reverse().join('')
---

{%%= user %}
{%%= reverse(user) %}