theme Rust

Theme adapters for SSG-native CSS variable integration

This module provides adapters that map semantic color names to the native CSS variables of various static site generators. By using inline styles that reference these variables, generated documentation automatically inherits the SSG's theme (including dark mode support) without shipping any external CSS.

Examples:

use plissken_core::render::{get_theme_adapter, ThemeAdapter};

let adapter = get_theme_adapter(Some("mkdocs-material"));
let style = format!("background: {}; color: {}", adapter.code_bg(), adapter.code_fg());
// Results in: "background: var(--md-code-bg-color); color: var(--md-code-fg-color)"

Structs

struct MkDocsMaterial

pub

Derives: Debug, Clone, Copy, Default

MkDocs Material theme adapter

Uses MkDocs Material's --md-* CSS custom properties for seamless integration with Material for MkDocs themes. Reference: https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/

struct MdBook

pub

Derives: Debug, Clone, Copy, Default

mdBook theme adapter

Uses mdBook's CSS custom properties for integration with mdBook themes. mdBook uses simpler variable names without a prefix. Reference: https://rust-lang.github.io/mdBook/format/theme/index.html

struct Minimal

pub

Derives: Debug, Clone, Copy, Default

Minimal theme adapter with hardcoded fallback colors

Provides reasonable default colors for contexts where CSS variables are not available (plain markdown viewers, unstyled HTML, etc.). Uses a light theme with accessible contrast ratios.

Functions

fn get_theme_adapter

pub

fn get_theme_adapter (template : Option < & str >) -> Box < dyn ThemeAdapter >

Get a theme adapter based on the template name from config.

Returns the appropriate adapter for known SSG templates, or the Minimal adapter as a fallback for unknown templates.

Parameters:

Name	Type	Description
template	-	Optional template name from output.template in config

Returns:

A boxed trait object implementing ThemeAdapter

Examples:

use plissken_core::render::get_theme_adapter;

// Known templates
let mkdocs = get_theme_adapter(Some("mkdocs-material"));
assert_eq!(mkdocs.name(), "mkdocs-material");

let mdbook = get_theme_adapter(Some("mdbook"));
assert_eq!(mdbook.name(), "mdbook");

// Unknown or missing template falls back to minimal
let minimal = get_theme_adapter(None);
assert_eq!(minimal.name(), "minimal");

Source

pub fn get_theme_adapter(template: Option<&str>) -> Box<dyn ThemeAdapter> {
    match template {
        Some(t) => match t.to_lowercase().as_str() {
            "mkdocs-material" | "mkdocs_material" | "material" => Box::new(MkDocsMaterial),
            "mdbook" | "md-book" | "md_book" => Box::new(MdBook),
            _ => Box::new(Minimal),
        },
        None => Box::new(Minimal),
    }
}