Struct CompileConfig 

pub struct CompileConfig {

    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 mermaid: Option<MermaidOptions>,
    pub math_engine: Option<MathEngine>,
    pub force_sidecar: bool,
    pub allow_dangerous_html: bool,
    pub prefer_sidecar: Vec<String>,
}

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>

None = bundled defaults (Catppuccin Latte/Mocha, CSS-vars output).

mermaid: Option<MermaidOptions>

None = bundled defaults (light+dark, htmlLabels:false, responsive SVG).

math_engine: Option<MathEngine>

None = KaTeX (rehype-katex parity); Some(Mathml) = pulldown-latex (fast).

force_sidecar: bool

Force every listed JS plugin to the sidecar; drop every native transformer.

allow_dangerous_html: bool

SEC-010: raw embedded HTML passthrough (CommonMark “unsafe” mode). When false (the default), attacker-supplied <script> / <iframe> / on*= markup is NOT emitted verbatim into the HTML or MDX output — block-level raw HTML is dropped and inline raw HTML is escaped to visible text. Set true only when the caller fully trusts the input.

prefer_sidecar: Vec<String>

Per-plugin sidecar override. Recognised entries: “remark-gfm”, “remark-math”, “remark-emoji”, “rehype-pretty-code”, “shiki”, “rehype-katex”, “rehype-mathjax”, “rehype-slug”, “rehype-autolink-headings”.

Implementations

impl CompileConfig

pub fn new() -> Self

pub fn has_js_plugins(&self) -> bool

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

Drops JS plugins owned by an in-process transformer. When the matching feature is off, the plugin stays in the list and the sidecar runs it.

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

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

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

pub fn for_render(&self) -> Self

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

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

path resolves relative assets for copy-linked-files.

Trait Implementations

impl Clone for CompileConfig

fn clone(&self) -> CompileConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompileConfig

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

Formats the value using the given formatter.

impl Default for CompileConfig

fn default() -> Self

Returns the “default value” for a type.

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

where CompileConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CompileConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.