hexo/node_modules/hexo-front-matter/README.md

61 lines
1.3 KiB
Markdown
Raw Normal View History

2023-09-25 15:58:56 +08:00
# hexo-front-matter
[![Build Status](https://github.com/hexojs/hexo-front-matter/workflows/Tester/badge.svg)](https://github.com/hexojs/hexo-front-matter/actions?query=workflow%3ATester)
[![NPM version](https://badge.fury.io/js/hexo-front-matter.svg)](https://www.npmjs.com/package/hexo-front-matter)
[![Coverage Status](https://coveralls.io/repos/hexojs/hexo-front-matter/badge.svg?branch=master)](https://coveralls.io/r/hexojs/hexo-front-matter?branch=master)
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.
Option | Description | Default
--- | --- | ---
`mode` | The mode can be either `json` or `yaml`. | `yaml`
`separator` | Separator | `---`
`prefixSeparator` | Add prefixing separator. | `false`
### split(str)
Splits a YAML front-matter string.
### escape(str)
Converts hard tabs to soft tabs.
## License
MIT