Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
peterbe committed May 15, 2020
1 parent 1d9094f commit 60b3b67
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Expand Up @@ -72,7 +72,7 @@ And end up with an object like this:
var fm = require('front-matter')
```

## fm(string)
## fm(string, allowUnsafe = false)

Return a `content` object with two properties:

Expand All @@ -81,6 +81,9 @@ Return a `content` object with two properties:
* `content.bodyBegin` contains the line number the body contents begins at
* `content.frontmatter` contains the original yaml string contents

**NOTE:** By default `fm()` uses `ys-yaml`'s `safeLoad` unless you set the
optional second argument to true.

# fm.test(string)

Check if a string contains a front matter header of "---" or "= yaml =". Primarily used internally but is useful outside of the module.
Expand Down

0 comments on commit 60b3b67

Please sign in to comment.