Struct HtmlWriterOptions

pub struct HtmlWriterOptions {
    pub code_block_language_class_prefix: Option<EcoString>,
    pub strict: bool,
}

Options for configuring the HTML rendering process.

HtmlWriterOptions allows customizing how HTML is generated when rendering CommonMark content. These options can be used directly with an HtmlWriter or can be derived from a CommonMarkWriter’s options when rendering HTML elements within CommonMark content.

Example

use cmark_writer::{HtmlWriter, HtmlWriterOptions};

// Create custom HTML rendering options
let options = HtmlWriterOptions {
    strict: true,
    code_block_language_class_prefix: Some("language-".into()),
    #[cfg(feature = "gfm")]
    enable_gfm: true,
    #[cfg(feature = "gfm")]
    gfm_disallowed_html_tags: vec!["script".into()],
};

// Use the options with an HtmlWriter
let mut writer = HtmlWriter::with_options(options);

Fields

code_block_language_class_prefix: Option<EcoString>

A prefix for the class name applied to fenced code blocks. For example, if set to “lang-”, a Rust code block might get class “lang-rust”. If None, no language class is added.

strict: bool

Determines if HTML parsing/rendering errors should be strict (panic/Err) or lenient (warn and attempt to recover/textualize).

Trait Implementations

impl Clone for HtmlWriterOptions

fn clone(&self) -> HtmlWriterOptions

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HtmlWriterOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for HtmlWriterOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for HtmlWriterOptions

fn eq(&self, other: &HtmlWriterOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for HtmlWriterOptions

impl StructuralPartialEq for HtmlWriterOptions