remark-frontmatter
Advanced tools
Comparing version 1.3.1 to 1.3.2
@@ -19,3 +19,3 @@ 'use strict' | ||
/* One preset or matter. */ | ||
// One preset or matter. | ||
if (typeof options === 'string' || !('length' in options)) { | ||
@@ -22,0 +22,0 @@ options = [options] |
{ | ||
"name": "remark-frontmatter", | ||
"version": "1.3.1", | ||
"description": "Frontmatter (yaml, toml, and more) support for remark", | ||
"version": "1.3.2", | ||
"description": "remark plugin to support frontmatter (yaml, toml, and more)", | ||
"license": "MIT", | ||
"keywords": [ | ||
"unified", | ||
"remark", | ||
"plugin", | ||
"mdast", | ||
"markdown", | ||
"frontmatter", | ||
"yaml", | ||
"toml", | ||
"markdown", | ||
"remark" | ||
"toml" | ||
], | ||
@@ -18,2 +21,3 @@ "repository": "remarkjs/remark-frontmatter", | ||
"Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)", | ||
"Lars Trieloff <lars@trieloff.net>", | ||
"Max Kueng <me@maxkueng.com>" | ||
@@ -31,14 +35,14 @@ ], | ||
"browserify": "^16.0.0", | ||
"is-hidden": "^1.1.0", | ||
"is-hidden": "^1.0.0", | ||
"not": "^0.1.0", | ||
"nyc": "^13.0.0", | ||
"prettier": "^1.14.2", | ||
"nyc": "^14.0.0", | ||
"prettier": "^1.0.0", | ||
"remark": "^10.0.0", | ||
"remark-cli": "^6.0.0", | ||
"remark-preset-wooorm": "^4.0.0", | ||
"tape": "^4.4.0", | ||
"tinyify": "^2.4.3", | ||
"to-vfile": "^5.0.0", | ||
"remark-preset-wooorm": "^5.0.0", | ||
"tape": "^4.0.0", | ||
"tinyify": "^2.0.0", | ||
"to-vfile": "^6.0.0", | ||
"unified": "^7.0.0", | ||
"xo": "^0.23.0" | ||
"xo": "^0.24.0" | ||
}, | ||
@@ -45,0 +49,0 @@ "scripts": { |
@@ -6,17 +6,18 @@ # remark-frontmatter | ||
[![Downloads][downloads-badge]][downloads] | ||
[![Chat][chat-badge]][chat] | ||
[![Size][size-badge]][size] | ||
[![Sponsors][sponsors-badge]][collective] | ||
[![Backers][backers-badge]][collective] | ||
[![Chat][chat-badge]][chat] | ||
Frontmatter (YAML, TOML, and more) support for [**remark**][remark]. | ||
[**remark**][remark] plugin to support frontmatter (YAML, TOML, and more). | ||
## Installation | ||
## Install | ||
[npm][]: | ||
```bash | ||
```sh | ||
npm install remark-frontmatter | ||
``` | ||
## Usage | ||
## Use | ||
@@ -35,3 +36,3 @@ Say we have the following file, `example.md`: | ||
```javascript | ||
```js | ||
var vfile = require('to-vfile') | ||
@@ -85,4 +86,5 @@ var report = require('vfile-reporter') | ||
### `remark.use(frontmatter[, options])` | ||
### `remark().use(frontmatter[, options])` | ||
Support frontmatter (YAML, TOML, and more). | ||
Adds [tokenizers][] if the [processor][] is configured with | ||
@@ -93,3 +95,3 @@ [`remark-parse`][parse], and [visitors][] if configured with | ||
If you are parsing from a different syntax, or compiling to a different syntax | ||
(e.g., [`remark-man`][man]) your custom nodes may not be supported. | ||
(such as, [`remark-man`][man]) your custom nodes may not be supported. | ||
@@ -212,7 +214,9 @@ ##### `options` | ||
See [`contributing.md` in `remarkjs/remark`][contributing] for ways to get | ||
started. | ||
See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways | ||
to get started. | ||
See [`support.md`][support] for ways to get help. | ||
This organisation has a [Code of Conduct][coc]. By interacting with this | ||
repository, organisation, or community you agree to abide by its terms. | ||
This project has a [Code of Conduct][coc]. | ||
By interacting with this repository, organisation, or community you agree to | ||
abide by its terms. | ||
@@ -225,3 +229,3 @@ ## License | ||
[build-badge]: https://img.shields.io/travis/remarkjs/remark-frontmatter.svg | ||
[build-badge]: https://img.shields.io/travis/remarkjs/remark-frontmatter/master.svg | ||
@@ -238,5 +242,5 @@ [build]: https://travis-ci.org/remarkjs/remark-frontmatter | ||
[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg | ||
[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-frontmatter.svg | ||
[chat]: https://spectrum.chat/unified/remark | ||
[size]: https://bundlephobia.com/result?p=remark-frontmatter | ||
@@ -249,2 +253,16 @@ [sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg | ||
[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg | ||
[chat]: https://spectrum.chat/unified/remark | ||
[npm]: https://docs.npmjs.com/cli/install | ||
[health]: https://github.com/remarkjs/.github | ||
[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md | ||
[support]: https://github.com/remarkjs/.github/blob/master/support.md | ||
[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md | ||
[license]: license | ||
@@ -254,4 +272,2 @@ | ||
[npm]: https://docs.npmjs.com/cli/install | ||
[remark]: https://github.com/remarkjs/remark | ||
@@ -271,10 +287,6 @@ | ||
[man]: https://github.com/remarkjs/remark-man | ||
[preset]: #preset | ||
[matter]: #matter | ||
[man]: https://github.com/remarkjs/remark-man | ||
[contributing]: https://github.com/remarkjs/remark/blob/master/contributing.md | ||
[coc]: https://github.com/remarkjs/remark/blob/master/code-of-conduct.md |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
14030
283