Struct MarkdownOptions

pub struct MarkdownOptions<'a> {
    pub comrak_options: ComrakOptions<'a>,
    pub enable_custom_blocks: bool,
    pub enable_syntax_highlighting: bool,
    pub enable_enhanced_tables: bool,
    pub syntax_theme: Option<String>,
}

Options for configuring Markdown processing behavior.

Fields

comrak_options: ComrakOptions<'a>

Options for the underlying Comrak Markdown parser.

enable_custom_blocks: bool

Enable or disable processing of custom blocks (e.g., note, warning, tip).

enable_syntax_highlighting: bool

Enable or disable syntax highlighting for code blocks.

enable_enhanced_tables: bool

Enable or disable enhanced table formatting.

syntax_theme: Option<String>

Optional custom theme for syntax highlighting.

Implementations

impl<'a> MarkdownOptions<'a>

pub fn new() -> Self

Creates a new instance of MarkdownOptions with default values.

pub fn with_custom_blocks(self, enable: bool) -> Self

Enables or disables custom blocks.

pub fn with_syntax_highlighting(self, enable: bool) -> Self

Enables or disables syntax highlighting for code blocks.

pub fn with_enhanced_tables(self, enable: bool) -> Self

Enables or disables enhanced table formatting.

pub fn with_custom_theme(self, theme: String) -> Self

Sets a custom theme for syntax highlighting.

pub fn with_comrak_options(self, options: ComrakOptions<'a>) -> Self

Sets custom Comrak options.

pub fn validate(&self) -> Result<(), String>

Validates the MarkdownOptions to ensure they are consistent and compatible.

Trait Implementations

impl<'a> Clone for MarkdownOptions<'a>

fn clone(&self) -> MarkdownOptions<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MarkdownOptions<'_>

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

Formats the value using the given formatter.

impl<'a> Default for MarkdownOptions<'a>

fn default() -> Self

Provides default options where custom blocks, syntax highlighting, and enhanced tables are all enabled, with default theme.