Skip to main content

MarkdownParser

Struct MarkdownParser 

Source
pub struct MarkdownParser { /* private fields */ }
Expand description

Markdown parser for parsing and rendering markdown documents

Implementations§

Source§

impl MarkdownParser

Source

pub fn new() -> Self

Create a new markdown parser with default options

Source

pub fn with_options(options: MarkdownOptions) -> Self

Create a new markdown parser with custom options

Source

pub fn extract_toc(content: &str) -> Vec<TocEntry>

Extract table of contents headings from markdown content.

Returns heading level (1-6), slug, and text for each heading found outside of code blocks.

Source

pub fn extract_embeds(content: &str) -> Vec<EmbedBlock>

Extract embed blocks !{type id} from content.

Recognized types: youtube, vimeo, figma, mermaid, plantuml, codepen, github. Skips content inside code blocks.

Source

pub fn extract_block_references( &self, content: &str, ) -> Vec<(usize, BlockReference)>

Extract block references (transclusions) from markdown content.

Parses ![[target]], ![[target#heading]], ![[target#^block-id]] syntax. Skips references inside code blocks and inline code.

Returns the block references found and their positions.

Extract all wikilink targets from content (without converting)

Source

pub fn parse<S: AsRef<str>>( &self, markdown: S, format: OutputFormat, ) -> Result<RenderResult>

Parse markdown content

Trait Implementations§

Source§

impl Default for MarkdownParser

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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> 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, 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.
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