Struct RenderCompat 

pub struct RenderCompat { /* private fields */ }

Math-renderer compatibility lint. Construct with new() for the MathJax v3 default profile; the CLI swaps in a config-derived profile via with_profile.

Implementations

impl RenderCompat

pub fn new() -> Self

pub fn with_profile(profile: RenderProfile) -> Self

Trait Implementations

impl Default for RenderCompat

fn default() -> Self

Returns the “default value” for a type.

impl LintRule for RenderCompat

fn name(&self) -> &str

Stable kebab-case identifier. Must be unique within any RuleSet.

fn description(&self) -> &str

One-line summary for mdwright list-rules.

fn is_default(&self) -> bool

Whether this rule is enabled in RuleSet::stdlib_defaults. Most rules are on by default; the few opinionated or repair-focused checks return false.

fn check(&self, doc: &Document, out: &mut Vec<Diagnostic>)

Run the check against a parsed document. Append diagnostics to out. The dispatcher fills in each diagnostic’s rule and advisory fields from self.name() and self.is_advisory() after the call returns.

fn is_advisory(&self) -> bool

Advisory rules emit informational diagnostics that do not fail mdwright check --check. Their output still prints.

fn produces_fix(&self) -> bool

Whether this rule can emit a crate::Fix. Used by mdwright list-rules and the generated rule docs. Defaults to false; stdlib rules that emit fixes override.

fn explain(&self) -> &str

Long-form explanation used by mdwright explain <rule> and the per-rule pages under docs/rules/. Returns an empty string by default so existing third-party rules continue to compile; stdlib rules override with a multi-paragraph markdown body (no frontmatter).