Astral.Markdown (Astral v0.2.0)

Copy Markdown View Source

Markdown rendering backed by MDEx.

Astral delegates Markdown parsing and frontmatter extraction to MDEx, then delegates frontmatter decoding to YamlElixir.

Summary

Functions

Render Markdown source to HTML and page metadata.

Convert Markdown source to HEEx-compatible HTML while preserving component tags.

Functions

render(source)

@spec render(String.t()) :: {:ok, Astral.Content.t()} | {:error, term()}

Render Markdown source to HTML and page metadata.

to_heex_html(source, opts \\ [])

@spec to_heex_html(
  String.t(),
  keyword()
) :: {:ok, String.t()} | {:error, term()}

Convert Markdown source to HEEx-compatible HTML while preserving component tags.