Comparing version 8.0.0 to 9.0.0
{ | ||
"name": "remark", | ||
"version": "8.0.0", | ||
"version": "9.0.0", | ||
"description": "Markdown processor powered by plugins", | ||
@@ -17,9 +17,9 @@ "license": "MIT", | ||
"dependencies": { | ||
"remark-parse": "^4.0.0", | ||
"remark-stringify": "^4.0.0", | ||
"remark-parse": "^5.0.0", | ||
"remark-stringify": "^5.0.0", | ||
"unified": "^6.0.0" | ||
}, | ||
"homepage": "http://remark.js.org", | ||
"repository": "https://github.com/wooorm/remark/tree/master/packages/remark", | ||
"bugs": "https://github.com/wooorm/remark/issues", | ||
"repository": "https://github.com/remarkjs/remark/tree/master/packages/remark", | ||
"bugs": "https://github.com/remarkjs/remark/issues", | ||
"author": "Titus Wormer <tituswormer@gmail.com> (http://wooorm.com)", | ||
@@ -26,0 +26,0 @@ "contributors": [ |
# remark [![Build Status][build-badge]][build-status] [![Coverage Status][coverage-badge]][coverage-status] [![Chat][chat-badge]][chat] | ||
The [**remark**][remark] processor is a markdown processor powered by | ||
[plug-ins][plugins]. | ||
The [`remark`][remark] processor is a markdown processor powered by | ||
[plugins][]. | ||
* Interface by [**unified**][unified] | ||
* Interface by [`unified`][unified] | ||
* [**MDAST**][mdast] syntax tree | ||
* Parses markdown to the tree with [**remark-parse**][parse] | ||
* [Plug-ins][plugins] transform the tree | ||
* Compiles the tree to markdown using [**remark-stringify**][stringify] | ||
* Parses markdown to the tree with [`remark-parse`][parse] | ||
* [Plugins][] transform the tree | ||
* Compiles the tree to markdown using [`remark-stringify`][stringify] | ||
@@ -24,2 +24,6 @@ Don’t need the parser? Or the compiler? [That’s OK][unified-usage]. | ||
###### Common example | ||
This example lints markdown and turns it into HTML. | ||
```js | ||
@@ -46,5 +50,54 @@ var remark = require('remark'); | ||
⚠ 1 warning | ||
``` | ||
```html | ||
<h2>Hello world!</h2> | ||
``` | ||
###### Settings through data | ||
This example prettifies markdown and configures [`remark-parse`][parse] and | ||
[`remark-stringify`][stringify] through [data][]. | ||
```js | ||
var remark = require('remark'); | ||
remark() | ||
.data('settings', {commonmark: true, emphasis: '*', strong: '*'}) | ||
.process('_Emphasis_ and __importance__', function (err, file) { | ||
if (err) throw err; | ||
console.log(String(file)); | ||
}); | ||
``` | ||
Yields: | ||
```markdown | ||
*Emphasis* and **importance** | ||
``` | ||
###### Settings through a preset | ||
This example prettifies markdown and configures [`remark-parse`][parse] and | ||
[`remark-stringify`][stringify] through a [preset][]. | ||
```js | ||
var remark = require('remark'); | ||
remark() | ||
.use({ | ||
settings: {commonmark: true, emphasis: '*', strong: '*'} | ||
}) | ||
.process('_Emphasis_ and __importance__', function (err, file) { | ||
if (err) throw err; | ||
console.log(String(file)); | ||
}); | ||
``` | ||
Yields: | ||
```markdown | ||
*Emphasis* and **importance** | ||
``` | ||
## License | ||
@@ -56,15 +109,15 @@ | ||
[build-badge]: https://img.shields.io/travis/wooorm/remark.svg | ||
[build-badge]: https://img.shields.io/travis/remarkjs/remark.svg | ||
[build-status]: https://travis-ci.org/wooorm/remark | ||
[build-status]: https://travis-ci.org/remarkjs/remark | ||
[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/remark.svg | ||
[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark.svg | ||
[coverage-status]: https://codecov.io/github/wooorm/remark | ||
[coverage-status]: https://codecov.io/github/remarkjs/remark | ||
[chat-badge]: https://img.shields.io/gitter/room/wooorm/remark.svg | ||
[chat-badge]: https://img.shields.io/gitter/room/remarkjs/Lobby.svg | ||
[chat]: https://gitter.im/wooorm/remark | ||
[chat]: https://gitter.im/remarkjs/Lobby | ||
[license]: https://github.com/wooorm/remark/blob/master/LICENSE | ||
[license]: https://github.com/remarkjs/remark/blob/master/LICENSE | ||
@@ -75,14 +128,18 @@ [author]: http://wooorm.com | ||
[remark]: https://github.com/wooorm/remark | ||
[remark]: https://github.com/remarkjs/remark | ||
[unified]: https://github.com/wooorm/unified | ||
[unified]: https://github.com/unifiedjs/unified | ||
[mdast]: https://github.com/wooorm/mdast | ||
[mdast]: https://github.com/syntax-tree/mdast | ||
[parse]: https://github.com/wooorm/remark/blob/master/packages/remark-parse | ||
[parse]: https://github.com/remarkjs/remark/blob/master/packages/remark-parse | ||
[stringify]: https://github.com/wooorm/remark/blob/master/packages/remark-stringify | ||
[stringify]: https://github.com/remarkjs/remark/blob/master/packages/remark-stringify | ||
[plugins]: https://github.com/wooorm/remark/blob/master/doc/plugins.md | ||
[plugins]: https://github.com/remarkjs/remark/blob/master/doc/plugins.md | ||
[unified-usage]: https://github.com/wooorm/unified#usage | ||
[unified-usage]: https://github.com/unifiedjs/unified#usage | ||
[preset]: https://github.com/unifiedjs/unified#preset | ||
[data]: https://github.com/unifiedjs/unified#processordatakey-value |
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
No bug tracker
MaintenancePackage does not have a linked bug tracker in package.json.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
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
No bug tracker
MaintenancePackage does not have a linked bug tracker in package.json.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
4243
142
+ Addedremark-parse@5.0.0(transitive)
+ Addedremark-stringify@5.0.0(transitive)
- Removedremark-parse@4.0.0(transitive)
- Removedremark-stringify@4.0.0(transitive)
Updatedremark-parse@^5.0.0
Updatedremark-stringify@^5.0.0