Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Oct 3, 2020
1 parent 0b1cd0a commit efa1a5a
Showing 1 changed file with 3 additions and 18 deletions.
21 changes: 3 additions & 18 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ var html = require('remark-html')
unified()
.use(markdown)
.use(html)
.process(fs.readFileSync('example.md'), function(err, file) {
.process(fs.readFileSync('example.md'), function (err, file) {
if (err) throw err
console.log(String(file))
})
Expand Down Expand Up @@ -95,8 +95,8 @@ How to sanitize the output (`Object` or `boolean`, default: `true`):
* `false`
— HTML is not sanitized, dangerous HTML persists
* `true`
— HTML is [`hast-util-sanitize`][sanitize] according to [GitHub’s sanitation
rules][github], dangerous HTML is dropped
— HTML is sanitized according to [GitHub’s sanitation rules][github],
dangerous HTML is dropped
* `Object`
— the object is treated as a `schema` for how to sanitize with
[`hast-util-sanitize`][sanitize], dangerous HTML is dropped
Expand All @@ -121,17 +121,6 @@ remark()
.processSync(/**/)
```

## CommonMark

> You still need to set `commonmark: true` in [`remark-parse`s
> options][remark-options].
[CommonMark][] support is a goal but not (yet) a necessity.
There are some (roughly 115 of 550, relating to inline precedence, lists,
emphasis and importance) issues which I’d like to cover in the future.
Note that this sounds like a lot, but they have to do with obscure differences
which do not often occur in the real world.

## Integrations

`remark-html` works great with:
Expand Down Expand Up @@ -251,8 +240,6 @@ abide by its terms.

[remark]: https://github.com/remarkjs/remark

[remark-options]: https://github.com/remarkjs/remark/tree/HEAD/packages/remark-parse#options

[remark-plugins]: https://github.com/remarkjs/remark/blob/HEAD/doc/plugins.md#list-of-plugins

[remark2rehype]: https://github.com/remarkjs/remark-rehype
Expand All @@ -279,8 +266,6 @@ abide by its terms.

[to-hast]: https://github.com/syntax-tree/mdast-util-to-hast#note

[commonmark]: https://commonmark.org

[integrations]: #integrations

[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting

0 comments on commit efa1a5a

Please sign in to comment.