Skip to content

Commit

Permalink
Mention --safe in README
Browse files Browse the repository at this point in the history
Signed-off-by: Ashe Connor <[email protected]>
  • Loading branch information
kivikakk committed May 7, 2018
1 parent af6e7d6 commit 4020ac8
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,8 @@ assert_eq!(

As with [`cmark-gfm`](https://github.com/github/cmark#security), Comrak will pass through inline HTML, dangerous links, anything you can imagine — it only performs Markdown to HTML conversion per the CommonMark/GFM spec. We recommend the use of a sanitisation library like [`ammonia`](https://github.com/notriddle/ammonia) configured specific to your needs.

You can also disable this potentially unsafe feature by using the `safe` option (or `--safe` at the command-line).

## Extensions

Comrak supports the five extensions to CommonMark defined in the
Expand Down

0 comments on commit 4020ac8

Please sign in to comment.