Struct MarkdownTheme 

pub struct MarkdownTheme {
    pub name: Option<String>,
    pub markdown_text: Option<ColorMapping>,
    pub markdown_heading: Option<ColorMapping>,
    pub markdown_code: Option<ColorMapping>,
    pub markdown_block_quote: Option<ColorMapping>,
    pub markdown_emph: Option<ColorMapping>,
    pub markdown_strong: Option<ColorMapping>,
    pub markdown_link: Option<ColorMapping>,
    pub markdown_hr: Option<ColorMapping>,
    pub markdown_table: Option<ColorMapping>,
}

Available on crate feature markdown-preview only.

Constructor functions for MarkdownTheme. Methods for MarkdownTheme. Markdown theme configuration struct.

The MarkdownTheme struct defines the color scheme for different markdown elements, supporting both light and dark mode variants through ColorMapping. Markdown theme configuration.

This struct holds color mappings for various markdown elements. Each field is optional, allowing themes to only override specific elements while inheriting defaults for others.

Fields

• name - Optional theme name for identification
• markdown_text - Color for regular text
• markdown_heading - Color for headings (h1-h6)
• markdown_code - Color for inline code and code blocks
• markdown_block_quote - Color for block quotes
• markdown_emph - Color for emphasized (italic) text
• markdown_strong - Color for strong (bold) text
• markdown_link - Color for links
• markdown_hr - Color for horizontal rules
• markdown_table - Color for tables

Example

use ratatui_toolkit::markdown_widget::extensions::theme::{MarkdownTheme, load_theme_from_json};

let json = r#"{
    "name": "my-theme",
    "markdown_heading": { "dark": "blue", "light": "oceanBlue" }
}"#;

let theme = load_theme_from_json(json).unwrap();
assert_eq!(theme.name, Some("my-theme".to_string()));

Fields

name: Option<String>

Optional theme name for identification.

markdown_text: Option<ColorMapping>

Color for regular text.

markdown_heading: Option<ColorMapping>

Color for headings (h1-h6).

markdown_code: Option<ColorMapping>

Color for inline code and code blocks.

markdown_block_quote: Option<ColorMapping>

Color for block quotes.

markdown_emph: Option<ColorMapping>

Color for emphasized (italic) text.

markdown_strong: Option<ColorMapping>

Color for strong (bold) text.

markdown_link: Option<ColorMapping>

Color for links.

markdown_hr: Option<ColorMapping>

Color for horizontal rules.

markdown_table: Option<ColorMapping>

Color for tables.

Trait Implementations

impl Clone for MarkdownTheme

fn clone(&self) -> MarkdownTheme

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MarkdownTheme

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

Formats the value using the given formatter.

impl Default for MarkdownTheme

fn default() -> MarkdownTheme

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MarkdownTheme

fn deserialize<__D>( __deserializer: __D, ) -> Result<MarkdownTheme, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.