NLdoc.Conversion.Writer.Tiptap (NLdoc.Conversion.Writer.Tiptap v2.0.1)

This writer converts NLdoc Spec objects to Tiptap Elements.

Summary

error()

input(resource)

opt()

output(value)

tiptap_element()

tiptap_mark()

Converts NLdoc Spec Document to Tiptap document

@type error() :: {:error, {:unsupported_resource, module()}}

@type input(resource) ::
  {resource, state :: NLdoc.Conversion.Writer.Tiptap.State.t(),
   ctx :: NLdoc.Conversion.Writer.Tiptap.Context.t()}

@type opt() :: {:strict, boolean()}

@type output(value) ::
  {:ok, {value, state :: NLdoc.Conversion.Writer.Tiptap.State.t()}} | error()

@type tiptap_attribute_map() :: %{required(atom()) => term()}

@type tiptap_element() :: %{required(atom()) => term()}

@type tiptap_mark() :: map()

@spec convert(doc :: NLdoc.Spec.Document.t(), opts :: [opt()]) ::
  {:ok, tiptap_element()} | error()

Converts NLdoc Spec Document to Tiptap document