Skip to content

Commit efa1a5a

Browse files
committed
Update docs
1 parent 0b1cd0a commit efa1a5a

File tree

1 file changed

+3
-18
lines changed

1 file changed

+3
-18
lines changed

readme.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ var html = require('remark-html')
5454
unified()
5555
.use(markdown)
5656
.use(html)
57-
.process(fs.readFileSync('example.md'), function(err, file) {
57+
.process(fs.readFileSync('example.md'), function (err, file) {
5858
if (err) throw err
5959
console.log(String(file))
6060
})
@@ -95,8 +95,8 @@ How to sanitize the output (`Object` or `boolean`, default: `true`):
9595
* `false`
9696
— HTML is not sanitized, dangerous HTML persists
9797
* `true`
98-
— HTML is [`hast-util-sanitize`][sanitize] according to [GitHub’s sanitation
99-
rules][github], dangerous HTML is dropped
98+
— HTML is sanitized according to [GitHub’s sanitation rules][github],
99+
dangerous HTML is dropped
100100
* `Object`
101101
— the object is treated as a `schema` for how to sanitize with
102102
[`hast-util-sanitize`][sanitize], dangerous HTML is dropped
@@ -121,17 +121,6 @@ remark()
121121
.processSync(/**/)
122122
```
123123

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

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

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

254-
[remark-options]: https://github.com/remarkjs/remark/tree/HEAD/packages/remark-parse#options
255-
256243
[remark-plugins]: https://github.com/remarkjs/remark/blob/HEAD/doc/plugins.md#list-of-plugins
257244

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

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

282-
[commonmark]: https://commonmark.org
283-
284269
[integrations]: #integrations
285270

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

0 commit comments

Comments
 (0)