# front-matter

**Repository Path**: mirrors_jsantell/front-matter

## Basic Information

- **Project Name**: front-matter
- **Description**: Extract YAML front matter from strings
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2026-05-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

node-front-matter
=================

http://en.wikipedia.org/wiki/YAML

Extract YAML front matter from strings.

So you have this file `example.md`:

    ---
    title:
    description:
    ---

    This is some content

Then you can do this:

    var frontmatter = require('front-matter')
      , extract = frontmatter(data)


And end up with this:

    console.log(extract)

    { attributes: { title: 'example'
        , description: 'example description'
        }
      , body: '\nThis is some content\n'
    }