Vibe.Terminal.Markdown (vibe v0.2.1)

Copy Markdown View Source

Terminal renderer for Markdown, including MDEx streaming documents.

Summary

Types

stream_state()

Functions

new_stream()
put_chunk(document, chunk)
render(markdown, width, theme \\ Theme.default())
render_document(document, width, theme, opts \\ [])
render_stream(document, width, theme \\ Theme.default())

Types

stream_state()

@type stream_state() :: MDEx.Document.t()

Functions

new_stream()

@spec new_stream() :: stream_state()

put_chunk(document, chunk)

@spec put_chunk(stream_state(), String.t()) :: stream_state()

render(markdown, width, theme \\ Theme.default())

@spec render(String.t(), pos_integer(), Vibe.Terminal.Theme.t()) :: [IO.chardata()]

render_document(document, width, theme, opts \\ [])

render_stream(document, width, theme \\ Theme.default())

@spec render_stream(stream_state(), pos_integer(), Vibe.Terminal.Theme.t()) :: [
  IO.chardata()
]