Skip to main content

MathRender

Enum MathRender 

Source
pub enum MathRender {
    None,
    CommonmarkKatex,
    Dollar,
}
Expand description

Delimiter rewrite policy for math regions at emit time.

mdwright never typesets math itself; downstream renderers (KaTeX, MathJax, mkdocs-material’s math plugin) do that. The modes here determine the shape of the math regions in the formatted output so the downstream renderer recognises them.

  • Self::None (default): pass math regions through verbatim; today’s behaviour.
  • Self::CommonmarkKatex: same emission as None, but signals intent in build logs. The bracket/paren forms (\[…\], \(…\)) and dollar forms ($$…$$, $…$) are both recognised by KaTeX and MathJax v3 auto-renderers without rewriting.
  • Self::Dollar: rewrite \[ … \] to $$ … $$ and \( … \) to $ … $ at emit time. LaTeX environments (\begin{align*}…\end{align*}) are not rewritten; there is no dollar form of an environment.

Variants§

§

None

Pass math regions through verbatim.

§

CommonmarkKatex

Pass through verbatim; greppable signal that downstream is KaTeX or MathJax over CommonMark-shaped math.

§

Dollar

Rewrite backslash-bracket / backslash-paren math to dollar form. Environments are left unchanged.

Trait Implementations§

Source§

impl Clone for MathRender

Source§

fn clone(&self) -> MathRender

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MathRender

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MathRender

Source§

fn default() -> MathRender

Returns the “default value” for a type. Read more
Source§

impl PartialEq for MathRender

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for MathRender

Source§

impl Eq for MathRender

Source§

impl StructuralPartialEq for MathRender

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more