Socket
Socket
Sign inDemoInstall

hexo-front-matter

Package Overview
Dependencies
2
Maintainers
8
Versions
16
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    hexo-front-matter

Front-matter parser.


Version published
Weekly downloads
15K
decreased by-27.05%
Maintainers
8
Install size
576 kB
Created
Weekly downloads
 

Readme

Source

hexo-front-matter

Build Status NPM version Coverage Status

Front-matter parser.

What is Front-matter?

Front-matter allows you to specify data at the top of a file. Here are two formats:

YAML front-matter

---
layout: false
title: "Hello world"
---
Lorem ipsum dolor sit amet, consectetur adipiscing elit.

JSON front-matter

;;;
"layout": false,
"title": "Hello world"
;;;
Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Prefixing separators are optional.

API

parse(str, [options])

Parses front-matter.

stringify(obj, [options])

Converts an object to a front-matter string.

OptionDescriptionDefault
modeThe mode can be either json or yaml.yaml
separatorSeparator---
prefixSeparatorAdd prefixing separator.false

split(str)

Splits a YAML front-matter string.

escape(str)

Converts hard tabs to soft tabs.

License

MIT

Keywords

FAQs

Last updated on 31 Oct 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc