Skip to content

Commit

Permalink
docs: Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
josecolella authored and flavorjones committed Dec 31, 2024
1 parent 9da4c19 commit 4b339a5
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 @@ -31,6 +31,7 @@ Active Record extensions for HTML sanitization are available in the [`loofah-act
* Add the _nofollow_ attribute to all hyperlinks.
* Add the _target=\_blank_ attribute to all hyperlinks.
* Remove _unprintable_ characters from text nodes.
* Modify _double breakpoints_ characters to paragraph nodes.
* Format markup as plain text, with (or without) sensible whitespace handling around block elements.
* Replace Rails's `strip_tags` and `sanitize` view helper methods.

Expand Down Expand Up @@ -235,6 +236,7 @@ doc.scrub!(:noopener) # adds rel="noopener" attribute to links
doc.scrub!(:noreferrer) # adds rel="noreferrer" attribute to links
doc.scrub!(:unprintable) # removes unprintable characters from text nodes
doc.scrub!(:targetblank) # adds target="_blank" attribute to links
doc.scrub!(:double_breakpoint) # removes double breakpoints to paragraph nodes
```

See `Loofah::Scrubbers` for more details and example usage.
Expand Down

0 comments on commit 4b339a5

Please sign in to comment.