2023-10-03 11:14:36 +08:00
|
|
|
# hexo-front-matter
|
|
|
|
|
|
|
|
|
|
[](https://github.com/hexojs/hexo-front-matter/actions?query=workflow%3ATester)
|
|
|
|
|
[](https://www.npmjs.com/package/hexo-front-matter)
|
|
|
|
|
[](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
|
|
|
|
|
|
2023-09-25 15:58:56 +08:00
|
|
|
MIT
|
