Crate html_generator

HTML Generator: A modern HTML generation and optimization library

html-generator is a comprehensive suite of tools for generating, optimizing, and managing HTML content with a focus on accessibility, SEO, and performance.

Features

• Markdown to HTML: Converts Markdown content and files to HTML with support for:

  • CommonMark syntax
  • GitHub Flavored Markdown
  • Custom extensions and plugins

• Accessibility:

  • Automated ARIA attribute generation
  • WCAG compliance checking
  • Semantic HTML optimization

• SEO Optimization:

  • Meta tag generation
  • Structured data (JSON-LD) support
  • OpenGraph and Twitter card generation

• Performance:

  • HTML minification
  • Async generation capabilities
  • Memory-efficient processing

Examples

use html_generator::{markdown_to_html, MarkdownConfig};

fn main() -> Result<(), html_generator::error::HtmlError> {
    let markdown = "# Hello World\n\nWelcome to HTML Generator.";
    let config = MarkdownConfig::default();
    let html = markdown_to_html(markdown, Some(config))?;
    println!("Generated HTML: {html}");
    Ok(())
}

Security Features

The library implements several security measures to protect against common vulnerabilities:

• Path Validation: Prevents directory traversal attacks through strict path checking
• Input Limits: Implements size restrictions to prevent denial of service attacks
• Unicode Safety: Provides proper handling of Unicode text to prevent encoding attacks
• Memory Safety: Leverages Rust’s memory safety guarantees
• Error Handling: Uses comprehensive error types to prevent undefined behavior

Architecture

The library is organized into several key modules:

• accessibility: ARIA attributes and WCAG compliance
• error: Error types and handling
• generator: Core HTML generation functionality
• performance: Optimization and minification
• seo: Search engine optimization features
• utils: Utility functions and helpers

Re-exports

• pub use crate::error::HtmlError;
• pub use accessibility::add_aria_attributes;
• pub use accessibility::validate_wcag;
• pub use generator::generate_html;
• pub use performance::async_generate_html;
• pub use performance::minify_html;
• pub use seo::generate_meta_tags;
• pub use seo::generate_structured_data;
• pub use utils::extract_front_matter;
• pub use utils::format_header_with_id_class;

Modules

• accessibility
  Accessibility-related functionality for HTML processing.
• constants
  Common constants used throughout the library.
• error
  Error types for HTML generation and processing.
• generator
  HTML generation module for converting Markdown to HTML.
• performance
  Performance optimization functionality for HTML processing.
• seo
  Search Engine Optimization (SEO) functionality for HTML processing.
• utils
  Utility functions for HTML and Markdown processing.

Structs

• HtmlConfig
  Configuration options for HTML generation.
• HtmlConfigBuilder
  Builder for constructing HtmlConfig instances.
• MarkdownConfig
  Configuration options for Markdown to HTML conversion.

Enums

• ConfigError
  Errors that can occur during configuration.
• OutputDestination
  Output destination for HTML generation.

Functions

• markdown_file_to_html
  Converts a Markdown file to HTML.
• markdown_to_html
  Converts Markdown content to HTML.
• validate_language_code
  Validates that a language code matches the BCP 47 format (e.g., “en-GB”).

Type Aliases

• Result
  Result type alias for library operations