Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

MarkdownVisualTheme

OfficeIMO.Markdown

Namespace
OfficeIMO.Markdown
Assembly
OfficeIMO.Markdown
Source revision
e163ccb36643 with working tree changes
Modifiers
sealed

Shared visual profile used to keep Markdown exports visually consistent across HTML, PDF, and Word.

Inheritance

  • object
  • MarkdownVisualTheme

Usage

Explore 17 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters 2

Constructors

public MarkdownVisualTheme() #

Creates a custom visual theme.

Methods

public MarkdownVisualTheme Clone() #

Creates a copy of this visual theme.

public static MarkdownVisualTheme Compact() #

Compact profile for dense technical notes.

Create 2 overloads
public static MarkdownVisualTheme Create(OfficeVisualThemeKind kind) #

Creates one of the built-in shared visual themes.

Parameters

kind OfficeIMO.Drawing.OfficeVisualThemeKind required
public static MarkdownVisualTheme Create(OfficeVisualThemeKind kind, MarkdownColorSchemeKind colorScheme) #

Creates one of the built-in shared visual themes and applies a built-in color scheme.

Parameters

kind OfficeIMO.Drawing.OfficeVisualThemeKind required
colorScheme OfficeIMO.Markdown.MarkdownColorSchemeKind required
public static MarkdownVisualTheme Default() #

Default shared visual theme used when exporters are asked to produce styled output without an explicit theme.

public static MarkdownVisualTheme GitHubLike() #

GitHub-inspired profile for README-style exports.

public static MarkdownVisualTheme Plain() #

Plain profile with minimal visual opinions.

public static MarkdownVisualTheme Report() #

Report-oriented profile with stronger hierarchy and tables.

public static MarkdownVisualTheme? ResolveOrDefault(MarkdownVisualTheme? theme, bool applyDefaultTheme = true) #

Returns a copy of the requested theme, or the default shared theme when enabled.

Parameters

theme OfficeIMO.Markdown.MarkdownVisualTheme? required
applyDefaultTheme bool = true optional
public static MarkdownVisualTheme TechnicalDocument() #

Polished profile for technical guides, specs, and READMEs.

TryCreate 2 overloads
public static bool TryCreate(string? name, out MarkdownVisualTheme? theme) #

Tries to create a built-in shared visual theme from an API or front-matter name.

Parameters

name string? required
theme OfficeIMO.Markdown.MarkdownVisualTheme? required

Returns

bool
public static bool TryCreate(string? name, MarkdownColorSchemeKind colorScheme, out MarkdownVisualTheme? theme) #

Tries to create a built-in shared visual theme from an API or front-matter name and applies a built-in color scheme.

Parameters

name string? required
colorScheme OfficeIMO.Markdown.MarkdownColorSchemeKind required
theme OfficeIMO.Markdown.MarkdownVisualTheme? required

Returns

bool
public MarkdownVisualTheme WithColors(string? accent = null, string? heading = null, string? text = null, string? mutedText = null, string? background = null, string? surface = null, string? border = null, string? codeBackground = null, string? tableHeaderBackground = null, string? tableHeaderText = null, string? tableStripeBackground = null) #

Returns a copy of this theme with selected palette colors overridden.

Parameters

accent string? = null optional
heading string? = null optional
text string? = null optional
mutedText string? = null optional
background string? = null optional
surface string? = null optional
border string? = null optional
codeBackground string? = null optional
tableHeaderBackground string? = null optional
tableHeaderText string? = null optional
tableStripeBackground string? = null optional
public MarkdownVisualTheme WithColorScheme(MarkdownColorSchemeKind scheme) #

Returns a copy of this theme with the requested color scheme applied.

Parameters

scheme OfficeIMO.Markdown.MarkdownColorSchemeKind required
public MarkdownVisualTheme WithTable(Action<MarkdownTableVisualStyle> configure) #

Returns a copy of this theme with table styling configured.

Parameters

configure System.Action<OfficeIMO.Markdown.MarkdownTableVisualStyle> required
public static MarkdownVisualTheme WordLike() #

Neutral Word-like profile for general documents.

Properties

public OfficeVisualThemeKind Kind { get; set; } #

Theme kind used for diagnostics and renderer mapping.

public string Name { get; set; } #

Human-readable theme name.

public MarkdownHtmlStyle HtmlStyle { get; set; } #

Preferred built-in HTML style preset when rendering this theme to HTML.

public MarkdownVisualPalette Palette { get; set; } #

Semantic color palette shared by exporters.

public MarkdownTableVisualStyle Table { get; set; } #

MarkdownTable styling shared by exporters.

public static IReadOnlyList<MarkdownVisualThemePreset> Presets { get; } #

Built-in visual theme presets callers can offer as stable choices.

public static IReadOnlyList<MarkdownColorSchemeKind> ColorSchemes { get; } #

Built-in accent color schemes that can be applied to any preset.