update docs, add descriptions for api methods

This commit is contained in:
Leo Horie 2016-12-02 17:51:07 -05:00
parent d56c30cc4a
commit cdb9017a72
25 changed files with 613 additions and 40 deletions

View file

@ -1,5 +1,6 @@
# trust(html)
- [Description](#description)
- [Signature](#signature)
- [How it works](#how-it-works)
- [Security considerations](#security-considerations)
@ -8,9 +9,15 @@
---
### Signature
### Description
Generates a trusted HTML [vnode](vnodes.md)
Turns an HTML string into unescaped HTML. **Do not use `m.trust` on unsanitized user input.**
Always try to use an [alternative method](#avoid-trusting-html) first, before considering using `m.trust`.
---
### Signature
`vnode = m.trust(html)`