Struct HtmlConfig

pub struct HtmlConfig {
    pub enable_syntax_highlighting: bool,
    pub syntax_theme: Option<String>,
    pub minify_output: bool,
    pub add_aria_attributes: bool,
    pub generate_structured_data: bool,
    pub max_input_size: usize,
    pub language: String,
    pub generate_toc: bool,
}

Configuration options for HTML generation.

Controls various aspects of the HTML generation process including syntax highlighting, accessibility features, and output formatting.

Fields

enable_syntax_highlighting: bool

Enable syntax highlighting for code blocks

syntax_theme: Option<String>

Theme to use for syntax highlighting

minify_output: bool

Minify the generated HTML output

add_aria_attributes: bool

Automatically add ARIA attributes for accessibility

generate_structured_data: bool

Generate structured data (JSON-LD) based on content

max_input_size: usize

Maximum size (in bytes) for input content

language: String

Language for generated content

generate_toc: bool

Enable table of contents generation

Implementations

impl HtmlConfig

pub fn builder() -> HtmlConfigBuilder

Creates a new HtmlConfig using the builder pattern.

Examples

use html_generator::HtmlConfig;

let config = HtmlConfig::builder()
    .with_syntax_highlighting(true, Some("monokai".to_string()))
    .with_language("en-GB")
    .build()
    .unwrap();

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

Validates the configuration settings.

Checks that all configuration values are within acceptable ranges and conform to required formats.

Returns

Returns Ok(()) if the configuration is valid, or an appropriate error if validation fails.

Trait Implementations

impl Clone for HtmlConfig

fn clone(&self) -> HtmlConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HtmlConfig

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

Formats the value using the given formatter.

impl Default for HtmlConfig

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for HtmlConfig

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

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

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 HtmlConfig

impl StructuralPartialEq for HtmlConfig