MDExNative.Ammonia (MDExNative v0.1.0)

Copy Markdown View Source

HTML sanitization powered by the Rust ammonia crate.

Summary

Functions

Sanitizes an HTML string with native Ammonia options.

Types

options()

@type options() :: [
  sanitize: sanitize_option(),
  escape_content: boolean(),
  escape_curly_braces_in_code: boolean()
]

sanitize_option()

@type sanitize_option() :: nil | :default | :clean | {:custom, map()}

Functions

safe_html(html, opts \\ [])

@spec safe_html(String.t(), options()) :: String.t()

Sanitizes an HTML string with native Ammonia options.

Options

  • :sanitize - sanitize_option/0. Defaults to :default, which uses Ammonia's default cleaner. Pass nil to skip sanitization.
  • :escape_content - boolean/0. Defaults to false. Escapes the full sanitized HTML string when enabled.
  • :escape_curly_braces_in_code - boolean/0. Defaults to true. Escapes { and } inside <code> tags.