front-matter vs gray-matter vs js-yaml vs yaml-front-matter vs yamljs
Markdown Front Matter Parsing Libraries
Search packages..
front-mattergray-matterjs-yamlyaml-front-matteryamljsSimilar Packages:

Markdown Front Matter Parsing Libraries

These libraries are designed to parse front matter from Markdown files, allowing developers to extract metadata and configuration settings from the top of Markdown documents. This is particularly useful in static site generators and content management systems where metadata is often used to control how content is displayed or processed. Each library offers unique features and syntax support, catering to different use cases and preferences in handling YAML and front matter formats.

Npm Package Weekly Downloads Trend

3 Years

Github Stars Ranking

Stat Detail

Package
Downloads
Stars
Size
Issues
Publish
License
front-matter0695-326 years agoMIT
gray-matter04,483-785 years agoMIT
js-yaml06,6191.45 MB711 days agoMIT
yaml-front-matter0194-216 years agoMIT
yamljs0886-539 years agoMIT

Feature Comparison: front-matter vs gray-matter vs js-yaml vs yaml-front-matter vs yamljs

Parsing Capabilities

  • front-matter:

    front-matter provides a simple API to extract front matter from Markdown files. It supports basic YAML syntax and is optimized for performance, making it ideal for projects that require minimal overhead.

  • gray-matter:

    gray-matter excels in parsing both YAML and JSON front matter, offering flexibility with custom delimiters. It also allows you to parse the content of the Markdown file alongside the front matter, which is useful for static site generators.

  • js-yaml:

    js-yaml is a powerful YAML parser that can handle complex YAML structures, including nested objects and arrays. It is not specifically designed for front matter but is excellent for general YAML parsing needs.

  • yaml-front-matter:

    yaml-front-matter combines YAML parsing with front matter extraction, allowing you to easily manage metadata in Markdown files. It provides a straightforward API for accessing front matter and the remaining content of the Markdown file.

  • yamljs:

    yamljs is a comprehensive library for parsing and stringifying YAML. It supports advanced YAML features and is suitable for applications that require extensive manipulation of YAML data.

Ease of Use

  • front-matter:

    front-matter is designed for simplicity, making it easy to integrate into projects without a steep learning curve. Its API is intuitive, allowing developers to quickly extract front matter with minimal configuration.

  • gray-matter:

    gray-matter offers a user-friendly API that is easy to understand, especially for those familiar with Markdown. Its ability to handle different front matter formats makes it versatile for various projects.

  • js-yaml:

    js-yaml has a slightly steeper learning curve due to its extensive features, but it is well-documented, making it manageable for developers who need advanced YAML capabilities.

  • yaml-front-matter:

    yaml-front-matter is straightforward to use, providing clear methods for extracting front matter and content. Its API is designed to be intuitive for developers working with Markdown.

  • yamljs:

    yamljs is powerful but may require more effort to learn due to its comprehensive feature set. However, it provides detailed documentation to assist developers in utilizing its capabilities.

Performance

  • front-matter:

    front-matter is lightweight and optimized for performance, making it suitable for high-frequency parsing scenarios, such as in static site generators where speed is crucial.

  • gray-matter:

    gray-matter balances performance with flexibility, allowing for efficient parsing of front matter while also supporting additional features without significant overhead.

  • js-yaml:

    js-yaml is robust but may not be as fast as lighter libraries for simple front matter parsing. It is best used when complex YAML structures are involved, where its performance trade-offs are justified.

  • yaml-front-matter:

    yaml-front-matter performs well for typical front matter extraction tasks, but its performance may vary based on the complexity of the YAML content being parsed.

  • yamljs:

    yamljs is designed for comprehensive YAML handling, which may introduce some performance overhead compared to simpler libraries. It is best used when advanced YAML features are needed.

Community and Support

  • front-matter:

    front-matter has a smaller community compared to some alternatives, but it is actively maintained and sufficient for basic needs.

  • gray-matter:

    gray-matter enjoys a larger user base and community support, making it easier to find examples and solutions to common issues.

  • js-yaml:

    js-yaml has a strong community and extensive documentation, making it a reliable choice for developers needing support for YAML parsing.

  • yaml-front-matter:

    yaml-front-matter has a decent level of community support, with documentation that covers most use cases, although it may not be as extensive as larger libraries.

  • yamljs:

    yamljs has a solid community and is well-documented, providing ample resources for developers seeking help with YAML parsing and manipulation.

Extensibility

  • front-matter:

    front-matter is minimalistic and does not offer extensibility features, focusing solely on front matter parsing without additional functionalities.

  • gray-matter:

    gray-matter allows for some extensibility through custom delimiters and the ability to parse different content types, making it adaptable for various use cases.

  • js-yaml:

    js-yaml is highly extensible, allowing developers to define custom YAML types and tags, making it suitable for complex applications that require tailored YAML handling.

  • yaml-front-matter:

    yaml-front-matter provides basic extensibility for front matter management but is primarily focused on simplicity and ease of use.

  • yamljs:

    yamljs is very extensible, supporting custom YAML types and advanced features, making it a great choice for projects that require extensive YAML manipulation.

How to Choose: front-matter vs gray-matter vs js-yaml vs yaml-front-matter vs yamljs

  • front-matter:

    Choose front-matter if you need a lightweight and straightforward library that focuses solely on parsing front matter from Markdown files without any additional dependencies or complexity.

  • gray-matter:

    Opt for gray-matter if you want a more versatile solution that can handle both YAML and JSON front matter, and provides additional features like custom delimiters and the ability to parse Markdown content along with the front matter.

  • js-yaml:

    Select js-yaml if your primary need is robust YAML parsing and stringifying, especially if you require advanced YAML features like support for complex data types or custom YAML tags, and you don't specifically need front matter parsing.

  • yaml-front-matter:

    Use yaml-front-matter if you prefer a library that combines YAML parsing with front matter extraction, and you want a simple API that allows you to easily manage front matter in your Markdown files.

  • yamljs:

    Choose yamljs if you need a comprehensive YAML parser and serializer that can handle complex YAML structures, and you want the flexibility to work with YAML data beyond just front matter.

Similar Npm Packages to front-matter

front-matter is a lightweight npm package designed for parsing front matter from files, typically used in static site generators and content management systems. Front matter refers to the metadata that is placed at the top of a file, often in YAML or TOML format, which provides information about the content such as title, date, tags, and more. The front-matter package allows developers to easily extract this metadata from their files, making it a valuable tool for managing content in a structured way.

While front-matter is a popular choice, there are other libraries that offer similar functionality. Here are a few alternatives:

  • gray-matter is a widely used library for parsing front matter from Markdown and other text files. It supports multiple formats, including YAML, TOML, and JSON, making it versatile for various use cases. gray-matter not only extracts the front matter but also returns the content of the file without the metadata, allowing for easy integration into static site generators and other applications. If you need a robust solution that can handle different front matter formats, gray-matter is an excellent choice.
  • yaml-front-matter is another library focused specifically on parsing YAML front matter. It provides a straightforward API for extracting metadata from files that use YAML format for their front matter. If your project primarily uses YAML and you want a dedicated solution for handling it, yaml-front-matter is a lightweight and efficient option.

To see how front-matter compares with gray-matter and yaml-front-matter, check out the comparison: Comparing front-matter vs gray-matter vs yaml-front-matter.

Similar Npm Packages to gray-matter

gray-matter is a popular npm package used for parsing front matter from Markdown files. Front matter is a section at the beginning of a Markdown document that contains metadata about the content, typically formatted in YAML or JSON. gray-matter allows developers to easily extract this metadata and separate it from the actual content, making it a valuable tool for static site generators and content management systems. Its ability to handle various formats and its straightforward API make it a go-to choice for many developers working with Markdown.

While gray-matter is a solid choice for parsing front matter, there are several alternatives that offer similar functionality:

  • front-matter is a lightweight library that focuses specifically on parsing front matter from Markdown files. It provides a simple API for extracting the metadata and content from the document. If you are looking for a minimalistic solution without additional features, front-matter is a great option that offers straightforward parsing capabilities.
  • remark-frontmatter is a plugin for the remark Markdown processor that allows you to work with front matter in Markdown files. It integrates seamlessly with the remark ecosystem, making it a good choice if you are already using remark for processing Markdown. This plugin enables you to parse front matter while leveraging the full power of remark for transforming Markdown content.
  • yaml-front-matter is another alternative that specifically focuses on parsing YAML front matter. It provides a simple API for extracting metadata from YAML-formatted front matter in Markdown files. If your project primarily uses YAML for front matter and you want a dedicated solution, yaml-front-matter is an excellent choice.

To see how these packages compare, check out the comparison: Comparing front-matter vs gray-matter vs remark-frontmatter vs yaml-front-matter.

Similar Npm Packages to js-yaml

js-yaml is a popular JavaScript library for parsing and dumping YAML (YAML Ain't Markup Language) data. It allows developers to easily convert YAML data into JavaScript objects and vice versa, making it a valuable tool for applications that require configuration files or data serialization in YAML format. While js-yaml is widely used, there are several alternatives in the ecosystem that also provide YAML parsing and manipulation capabilities. Here are a few notable alternatives:

  • yaml is a modern YAML parser and serializer for JavaScript. It aims to provide a more robust and feature-rich alternative to js-yaml, with support for advanced YAML features and better performance. The library is designed to be easy to use and integrates well with both Node.js and browser environments. If you are looking for a library that offers more features and better performance for handling YAML data, yaml is a great option.
  • yaml-front-matter is a specialized library that focuses on parsing YAML front matter, which is commonly used in static site generators like Jekyll and Gatsby. This library allows developers to easily extract front matter from documents, making it particularly useful for managing metadata in markdown files. If your project involves working with markdown files that include YAML front matter, yaml-front-matter is a convenient choice.
  • yamljs is another library for parsing and dumping YAML in JavaScript. It offers a simple API for converting YAML to JavaScript objects and vice versa. While it may not have as many features as some of the other libraries, it is lightweight and easy to use, making it suitable for smaller projects or applications that require basic YAML functionality.

For a detailed comparison of these libraries, check out the link: Comparing js-yaml vs yaml vs yaml-front-matter vs yamljs.

Similar Npm Packages to yaml-front-matter

yaml-front-matter is a JavaScript library designed to parse YAML front matter from text files. Front matter is a common pattern used in static site generators and content management systems, where metadata is defined at the beginning of a file, typically in YAML format. This library allows developers to easily extract this metadata and the content of the file, making it a useful tool for managing structured data in markdown or other text-based formats.

While yaml-front-matter is a robust option for handling YAML front matter, there are several alternatives worth considering:

  • front-matter is a simple library that extracts front matter from markdown files. It supports both YAML and JSON formats, making it versatile for different use cases. If you're looking for a straightforward solution to parse front matter without the need for YAML-specific features, front-matter is a solid choice.
  • gray-matter is another popular library for parsing front matter, supporting multiple formats including YAML, JSON, and TOML. It is widely used in static site generators like Gatsby and Next.js. gray-matter provides additional features such as the ability to customize delimiters and parse front matter from various file types, making it a flexible option for developers who need more control over their front matter parsing.
  • js-yaml is a YAML parser and dumper for JavaScript. While it is not specifically designed for front matter, it can be used in conjunction with other libraries to handle YAML data. If your project requires extensive YAML parsing capabilities beyond just front matter, js-yaml is a powerful tool that can meet those needs.
  • yamljs is another library for parsing and dumping YAML in JavaScript. Similar to js-yaml, it is not specifically focused on front matter but can be used to work with YAML data in various contexts. If you need a lightweight library for general YAML handling, yamljs is a good option.

To compare these packages and find the best fit for your project, check out the comparison link: Comparing front-matter vs gray-matter vs js-yaml vs yaml-front-matter vs yamljs.

Similar Npm Packages to yamljs

yamljs is a JavaScript library that allows developers to parse and stringify YAML (YAML Ain't Markup Language) files easily. It provides a straightforward API for working with YAML data, making it a popular choice for applications that require configuration files or data interchange in a human-readable format. While yamljs is a solid option for handling YAML, there are other libraries available that also serve this purpose. Here are a few alternatives:

  • js-yaml is a widely used library for parsing and dumping YAML in JavaScript. It is known for its performance and flexibility, supporting both Node.js and browser environments. js-yaml is particularly useful for developers who need to work with YAML in various contexts, such as server-side applications or client-side scripts. Its robust feature set and active community make it a reliable choice for handling YAML data.
  • yaml is another modern YAML parser and serializer for JavaScript. It aims to provide a more complete and user-friendly interface compared to other libraries. yaml supports advanced features such as custom types and schema validation, making it suitable for complex applications that require more than just basic YAML parsing and stringification. If you need a library that offers both simplicity and advanced capabilities, yaml is an excellent option.

To see how yamljs compares with js-yaml and yaml, check out the comparison: Comparing js-yaml vs yaml vs yamljs.

README for front-matter

front-matter

build coverage npm github

Sauce Test Status

Extract meta data (front-matter) from documents.

This modules does not do any IO (file loading or reading), only extracting and parsing front matter from strings.

This concept that was originally introduced to me through the jekyll blogging system and is pretty useful where you want to be able to easily add meta-data to content without the need for a database. YAML is extracted from the the top of a file between matching separators of "---" or "= yaml =". It will also extract YAML between a separator and "...".

Install

With npm do:

npm install front-matter

Example

So you have a file example.md:

---
title: Just hack'n
description: Nothing to see here
---

This is some text about some stuff that happened sometime ago

NOTE: As of front-matter@2.0.0 valid front matter is considered to have the starting separator on the first line.

Then you can do this:

var fs = require('fs')
  , fm = require('front-matter')

fs.readFile('./example.md', 'utf8', function(err, data){
  if (err) throw err

  var content = fm(data)

  console.log(content)
})

And end up with an object like this:

{
    attributes: {
        title: 'Just hack\'n',
        description: 'Nothing to see here'
    },
    body: 'This is some text about some stuff that happened sometime ago',
    bodyBegin: 6,
    frontmatter: 'title: Just hack\'n\ndescription: Nothing to see here'
}

Methods

var fm = require('front-matter')

fm(string, { allowUnsafe: false })

Return a content object with two properties:

  • content.attributes contains the extracted yaml attributes in json form
  • content.body contains the string contents below the yaml separators
  • 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 allowUnsafe in the options object 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.

Returns true or false

    fm.test(string) #=> true || false

Contributing

front-matter is an OPEN Source Project so please help out by reporting bugs or forking and opening pull requests when possible.

standard

All code is linted/formatted using standard style, any non-conforming code can be automatically formatted using the the fmt make task: make fmt.

Maintainers

Contributors

This module is awesome because of all the folks who submitted pull requests:

CHANGELOG

3.0.0

  • CI only tests Node versions >= v6 (drops v4, and v5)

LICENSE (MIT)

Copyright (c) Jason Campbell ("Author")

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm-compare.com is an independent website designed to help developers choose the most suitable npm packages. We are not affiliated with npm, Inc, the official website for the npm registry. Note that npm is a registered trademark of npm, Inc. For more details, please refer to our Terms & Privacy.