Struct Options 

#[non_exhaustive]
pub struct Options<S: StyleSheet = DefaultStyleSheet> { /* private fields */ }

Collection of optional parameters that influence markdown rendering.

The generic S allows users to provide their own theme type that implements the StyleSheet trait. The default implementation is DefaultStyleSheet, which provides a set of sensible defaults for styling markdown elements.

Example

use tui_markdown::{DefaultStyleSheet, Options};
let options = Options::default();

// or with a custom style sheet

use ratatui_core::style::{Style, Stylize};
use tui_markdown::StyleSheet;

#[derive(Debug, Clone)]
struct MyStyleSheet;

impl StyleSheet for MyStyleSheet {
    fn heading(&self, level: u8) -> Style {
        Style::new().bold()
    }

    fn code(&self) -> Style {
        Style::new().white().on_dark_gray()
    }

    fn link(&self) -> Style {
        Style::new().blue().underlined()
    }

    fn blockquote(&self) -> Style {
        Style::new().yellow()
    }

    fn heading_meta(&self) -> Style {
        Style::new().dim()
    }

    fn metadata_block(&self) -> Style {
        Style::new().light_yellow()
    }
}

let options = Options::new(MyStyleSheet);

Implementations

impl<S: StyleSheet> Options<S>

pub fn new(styles: S) -> Self

Creates a new Options instance with the provided style sheet.

Trait Implementations

impl<S: Clone + StyleSheet> Clone for Options<S>

fn clone(&self) -> Options<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug + StyleSheet> Debug for Options<S>

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

Formats the value using the given formatter.

impl Default for Options<DefaultStyleSheet>

fn default() -> Self

Returns the “default value” for a type.