https://github.com/izolate/front-matter

Extracts YAML front matter from a file or string
https://github.com/izolate/front-matter

dart front-matter markdown parser static-site-generator yaml

Last synced: 4 months ago
JSON representation

Extracts YAML front matter from a file or string

• Host: GitHub
• URL: https://github.com/izolate/front-matter
• Owner: izolate
• License: mit
• Created: 2019-06-08T17:27:36.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-06-28T01:04:55.000Z (over 1 year ago)
• Last Synced: 2024-10-11T23:09:08.117Z (4 months ago)
• Topics: dart, front-matter, markdown, parser, static-site-generator, yaml
• Language: Dart
• Homepage: https://pub.dev/packages/front_matter
• Size: 233 KB
• Stars: 5
• Watchers: 1
• Forks: 6
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Front Matter

A front matter parser that extracts YAML metadata from the start of a file or string.

[![Build Status](https://travis-ci.org/izolate/front-matter.svg?branch=master)](https://travis-ci.org/izolate/front-matter)

Front matter is a concept heavily borrowed from [Jekyll](https://github.com/jekyll/jekyll), and other static site generators, referring to a block of YAML in the header of a file representing the file's metadata.

## Usage

Suppose you have the following Markdown file:

```markdown

---

title: "Hello, world!"

author: "izolate"

---

This is an example.

```

Use `parse` to parse a string, or `parseFile` to read a file and parse its contents.

```dart

import 'dart:io';

import 'package:front_matter/front_matter.dart' as fm;

// Example 1 - parse a string.

void example1() async {

  var file = File('/path/to/file.md');

  var fileContents = await file.readAsString();

  var doc = fm.parse(fileContents);

  

  print(doc.data['title']); // "Hello, world!"

  print(doc.content);       // "This is an example."

}

// Example 2 - read file and parse contents.

void example2() async {

  var doc = await fm.parseFile('path/to/file.md');

  print(doc.data['title']); // "Hello, world!"

  print(doc.content);       // "This is an example."

}

```

The returned document is an instance of `FrontMatterDocument` with properties:

* `YamlMap data` - The front matter.

* `String content` - The content body.

To convert the document back to the initial string value, call `toString()`.

```dart

var text = '---\nfoo: bar\n---\nHello, world!';

var doc = fm.parse(text);

assert(doc.toString(), equals(text)); // true

```

### API

#### `parse(String text, {String delimiter = "---"})`

Parses a string, returns a `FrontMatterDocument` with front matter and body content.

#### `parseFile(String path, {String delimiter = "---"})`

Reads a file and parses its contents. Returns a `Future` with front matter and body content.