Skip to main content

Katex

Struct Katex 

Source
pub struct Katex {
    pub output: Option<KatexOutput>,
    pub leqno: bool,
    pub fleqn: bool,
    pub error_color: Option<String>,
    pub macros: BTreeMap<String, String>,
    pub min_rule_thickness: Option<f64>,
    pub color_is_text_color: bool,
    pub strict: Option<KatexStrict>,
    pub trust: bool,
    pub max_size: Option<f64>,
    pub max_expand: Option<usize>,
    pub global_group: bool,
}
Expand description

html.katex: math rendered as rehype-katex renders it, natively by katex-rs; options named as KaTeX names them.

Fields§

§output: Option<KatexOutput>

The markup to write, both HTML and MathML by default.

§leqno: bool

Put equation numbers on the left.

§fleqn: bool

Align display math to the left instead of centering it.

§error_color: Option<String>

The color of math that fails to render, #cc0000 by default.

§macros: BTreeMap<String, String>

Macros by name, each to the TeX it expands to, as {"\\RR": "\\mathbb{R}"}.

§min_rule_thickness: Option<f64>

The thinnest a rule, such as a fraction line, is drawn, in ems.

§color_is_text_color: bool

Let \color color the text after it, as LaTeX does.

§strict: Option<KatexStrict>

What to do with input LaTeX would reject: true or "error" fails it, "warn" prints a warning, false or "ignore" (the default) accepts it.

§trust: bool

Allow commands that can run untrusted input, such as \href and \includegraphics.

§max_size: Option<f64>

The largest a user-given size may be, in ems.

§max_expand: Option<usize>

How many macro expansions one formula may take, 1000 by default.

§global_group: bool

Let definitions such as \def last past the formula they are in.

Trait Implementations§

Source§

impl Clone for Katex

Source§

fn clone(&self) -> Self

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 Katex

Source§

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

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

impl Default for Katex

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for Katex
where Katex: Default,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Plugin for Katex

Source§

fn attach(&self, context: &mut Attach) -> Result<(), Error>

Source§

impl Transform for Katex

Source§

fn input(&self) -> TreeKind

Source§

fn output(&self) -> TreeKind

Source§

fn run<'a>( &self, tree: Tree<'a>, file: &mut File, alloc: &'a Allocator, ) -> Result<Tree<'a>, Error>

Source§

fn start<'a>( &self, tree: Tree<'a>, file: &mut File, alloc: &'a Bump, ) -> Result<Step<'a>, Error>

Start the stage: a finished tree, or a job when its work is asynchronous.
Source§

fn host(&self) -> Option<u32>

The id of the binding function this stage stands for, which takes and returns whatever tree reaches it; None for a stage the crate runs.
Source§

fn html_writer(&self, _target: HtmlTarget) -> Option<Box<dyn HtmlWriter>>

Something that writes, from this stage’s input, the HTML a compiler aiming at target would write from its output, when the stage can skip building that tree.

Auto Trait Implementations§

§

impl Freeze for Katex

§

impl RefUnwindSafe for Katex

§

impl Send for Katex

§

impl Sync for Katex

§

impl Unpin for Katex

§

impl UnsafeUnpin for Katex

§

impl UnwindSafe for Katex

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.