Skip to main content

CompileConfig

Struct CompileConfig 

Source
pub struct CompileConfig {
Show 14 fields pub markdown_gfm: bool, pub emit_html: bool, pub emit_body: bool, pub mdx_minify: bool, pub mdx_output_format: Option<String>, pub markdown_remark_plugins: Vec<Value>, pub markdown_rehype_plugins: Vec<Value>, pub mdx_remark_plugins: Vec<Value>, pub mdx_rehype_plugins: Vec<Value>, pub copy_linked_files: bool, pub output_assets: Option<String>, pub output_base: Option<String>, pub pretty_code: Option<PrettyCodeOptions>, pub math_engine: Option<MathEngine>,
}

Fields§

§markdown_gfm: bool§emit_html: bool§emit_body: bool§mdx_minify: bool§mdx_output_format: Option<String>§markdown_remark_plugins: Vec<Value>§markdown_rehype_plugins: Vec<Value>§mdx_remark_plugins: Vec<Value>§mdx_rehype_plugins: Vec<Value>§copy_linked_files: bool§output_assets: Option<String>§output_base: Option<String>§pretty_code: Option<PrettyCodeOptions>

Pretty-code highlighter config. None = bundled defaults (Catppuccin Latte/Mocha pair, dark primary, multi-mode CSS-vars output). Some = explicit theme spec.

§math_engine: Option<MathEngine>

LaTeX engine for $...$ / $$...$$. None = KaTeX (slow, exact rehype-katex parity). Some(MathEngine::Mathml) = pulldown-latex MathML (fast, plainer visuals).

Implementations§

Source§

impl CompileConfig

Source

pub fn new() -> Self

Source

pub fn has_js_plugins(&self) -> bool

Source

pub fn effective_markdown_remark_plugins(&self) -> Vec<Value>

Plugin lists after stripping every JS plugin whose work is now done by an in-process transformer (pretty-code/shiki, math, emoji). Used both for the sidecar gate and for the request payload so the sidecar never duplicates work. When the matching feature is off, that plugin’s name is left in the list and the sidecar runs it.

Source

pub fn effective_mdx_remark_plugins(&self) -> Vec<Value>

Source

pub fn effective_markdown_rehype_plugins(&self) -> Vec<Value>

Source

pub fn effective_mdx_rehype_plugins(&self) -> Vec<Value>

Source

pub fn for_render(&self) -> Self

Per-file compile config: turns off native HTML when sidecar will run.

Source

pub fn pipeline_config(&self, path: &Path) -> PipelineConfig

Build the PipelineConfig consumed by [Pipeline::with_defaults_for]. path is the compiled file’s path, used to resolve relative asset paths in the copy-linked-files transformer.

Trait Implementations§

Source§

impl Clone for CompileConfig

Source§

fn clone(&self) -> CompileConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CompileConfig

Source§

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

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

impl Default for CompileConfig

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for CompileConfig

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 Serialize for CompileConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

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, 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,