remark-frontmatter
Advanced tools
Comparing version 1.3.2 to 1.3.3
{ | ||
"name": "remark-frontmatter", | ||
"version": "1.3.2", | ||
"version": "1.3.3", | ||
"description": "remark plugin to support frontmatter (yaml, toml, and more)", | ||
@@ -9,2 +9,3 @@ "license": "MIT", | ||
"remark", | ||
"remark-plugin", | ||
"plugin", | ||
@@ -19,2 +20,6 @@ "mdast", | ||
"bugs": "https://github.com/remarkjs/remark-frontmatter/issues", | ||
"funding": { | ||
"type": "opencollective", | ||
"url": "https://opencollective.com/unified" | ||
}, | ||
"author": "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)", | ||
@@ -38,12 +43,12 @@ "contributors": [ | ||
"not": "^0.1.0", | ||
"nyc": "^14.0.0", | ||
"prettier": "^1.0.0", | ||
"remark": "^10.0.0", | ||
"remark-cli": "^6.0.0", | ||
"remark-preset-wooorm": "^5.0.0", | ||
"nyc": "^15.0.0", | ||
"prettier": "^2.0.0", | ||
"remark": "^11.0.0", | ||
"remark-cli": "^7.0.0", | ||
"remark-preset-wooorm": "^6.0.0", | ||
"tape": "^4.0.0", | ||
"tinyify": "^2.0.0", | ||
"to-vfile": "^6.0.0", | ||
"unified": "^7.0.0", | ||
"xo": "^0.24.0" | ||
"unified": "^8.0.0", | ||
"xo": "^0.28.0" | ||
}, | ||
@@ -50,0 +55,0 @@ "scripts": { |
@@ -110,14 +110,19 @@ # remark-frontmatter | ||
* `type` (`string`) — Node type to parse to in [mdast][] and compile from | ||
* `marker` (`string` or `{open: string, close: string}`) — Character used | ||
to construct fences. By providing an object with `open` and `close`. | ||
different characters can be used for opening and closing fences. For | ||
example the character `'-'` will result in `'---'` being used as the fence | ||
* `fence` (`string` or `{open: string, close: string}`) — String used as | ||
the complete fence. By providing an object with `open` and `close` | ||
different values can be used for opening and closing fences. This can be | ||
used too if fences contain different characters or lengths other than 3 | ||
* `anywhere` (`boolean`, default: `false`) – if `true`, matter can be | ||
found anywhere in the document. If `false` (default), only matter at the | ||
start of the document is recognised. | ||
* `type` (`string`) | ||
— Node type to parse to in [mdast][] and compile from | ||
* `marker` (`string` or `{open: string, close: string}`) | ||
— Character used to construct fences. | ||
By providing an object with `open` and `close`. | ||
different characters can be used for opening and closing fences. | ||
For example the character `'-'` will result in `'---'` being used as the | ||
fence | ||
* `fence` (`string` or `{open: string, close: string}`) | ||
— String used as the complete fence. | ||
By providing an object with `open` and `close` different values can be used | ||
for opening and closing fences. | ||
This can be used too if fences contain different characters or lengths other | ||
than 3 | ||
* `anywhere` (`boolean`, default: `false`) | ||
– if `true`, matter can be found anywhere in the document. | ||
If `false` (default), only matter at the start of the document is recognized | ||
@@ -143,4 +148,2 @@ ###### Example | ||
###### Example | ||
For `{type: 'custom', marker: {open: '<', close: '>'}}`: | ||
@@ -163,4 +166,2 @@ | ||
###### Example | ||
For `{type: 'custom', fence: '+=+=+=+'}`: | ||
@@ -179,8 +180,6 @@ | ||
"type": "custom", | ||
"value": "dats" | ||
"value": "data" | ||
} | ||
``` | ||
###### Example | ||
For `{type: 'json', fence: {open: '{', close: '}'}}`: | ||
@@ -203,2 +202,8 @@ | ||
## Security | ||
Use of `remark-frontmatter` does not involve [**rehype**][rehype] | ||
([**hast**][hast]) or user content so there are no openings for | ||
[cross-site scripting (XSS)][xss] attacks. | ||
## Related | ||
@@ -219,4 +224,4 @@ | ||
This project has a [Code of Conduct][coc]. | ||
By interacting with this repository, organisation, or community you agree to | ||
This project has a [code of conduct][coc]. | ||
By interacting with this repository, organization, or community you agree to | ||
abide by its terms. | ||
@@ -252,3 +257,3 @@ | ||
[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg | ||
[chat-badge]: https://img.shields.io/badge/chat-spectrum-7b16ff.svg | ||
@@ -290,1 +295,7 @@ [chat]: https://spectrum.chat/unified/remark | ||
[matter]: #matter | ||
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting | ||
[rehype]: https://github.com/rehypejs/rehype | ||
[hast]: https://github.com/syntax-tree/hast |
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
14429
294