Module `Quill_markdown`Source

Quill document model for representing markdown structures

Sourcetype inline_content =

| Run of string
| Emph of inline
| Strong of inline
| Code_span of string
| Seq of inline list
| Break of [ `Hard | `Soft ]
| Image of {
1. alt : inline;
2. src : string;
}
| Link of {
1. text : inline;
2. href : string;
}
| Raw_html of string

Inline content types

Sourceand inline = {

id : int;
inline_content : inline_content;
focused : bool;

}

Sourcetype codeblock_content = {

code : string;
output : block option;
info : string option;

}

Codeblock content with optional output

Sourceand block_content =

| Paragraph of inline
| Codeblock of codeblock_content
| Heading of int * inline
| Blank_line of unit
| Block_quote of block list
| Thematic_break
| List of list_type * list_spacing * block list list
| Html_block of string
| Link_reference_definition of Cmarkit.Link_definition.t Cmarkit.node
| Blocks of block list

Block content types

Sourceand list_type =

| Ordered of int * char
| Unordered of char

Sourceand list_spacing =

| Tight
| Loose

Sourceand block = {

id : int;
content : block_content;
focused : bool;

}

Sourcetype document = block list

Document type

Constructors

Sourceval inline : ?focused:bool -> inline_content -> inline

Create inline content

Sourceval run : ?focused:bool -> string -> inline

Sourceval emph : ?focused:bool -> inline -> inline

Sourceval strong : ?focused:bool -> inline -> inline

Sourceval code_span : ?focused:bool -> string -> inline

Sourceval seq : ?focused:bool -> inline list -> inline

Sourceval block : ?focused:bool -> block_content -> block

Create block content

Sourceval paragraph : ?focused:bool -> inline -> block

Source

val codeblock : 
  ?output:block ->
  ?info:string ->
  ?focused:bool ->
  string ->
  block

Sourceval heading : ?focused:bool -> int -> inline -> block

Sourceval blank_line : ?focused:bool -> unit -> block

Sourceval blocks : ?focused:bool -> block list -> block

Sourceval block_quote : ?focused:bool -> block list -> block

Sourceval thematic_break : ?focused:bool -> unit -> block

Source

val list : 
  ?focused:bool ->
  list_type ->
  list_spacing ->
  block list list ->
  block

Sourceval html_block : ?focused:bool -> string -> block

Source

val link_reference_definition : 
  ?focused:bool ->
  Cmarkit.Link_definition.t Cmarkit.node ->
  block

Sourceval init : document

Empty document

Parsing and Serialization

Sourceval document_of_md : string -> document

Parse markdown to document

Sourceval block_of_md : string -> block

Parse markdown to block

Sourceval block_content_of_md : string -> block_content

Parse markdown to block content

Sourceval inline_of_md : string -> inline

Parse markdown to inline

Sourceval inline_content_of_md : string -> inline_content

Parse markdown to inline content

Sourceval md_of_document : document -> string

Serialize document to markdown

Document Operations

Sourceval find_inline_in_block : block -> int -> inline option

Find inline by ID in a block

Sourceval replace_inline_in_block : block -> int -> inline -> block

Replace inline by ID in a block

Sourceval split_inline : inline -> int -> inline * inline

Split inline at offset

Sourceval set_focused_document_by_id : document -> int -> document

Set focused state by ID

Sourceval clear_focus_block : block -> block

Clear all focus

Sourceval clear_focus_inline : inline -> inline

Sourceval set_codeblock_output_in_block : block -> int -> block -> block

Set codeblock output

Sourceval normalize_blanklines : document -> document

Normalize blank lines

Sourceval inline_to_plain : inline -> string

Convert inline to plain text

Sourceval inline_content_to_plain : inline_content -> string

Internal

Sourceval reset_ids : unit -> unit

Reset ID counters (used for DOM parsing)

Install

Dune Dependency

Authors

Maintainers

Sources

doc/quill.markdown/Quill_markdown/index.html

Module `Quill_markdown`Source

Constructors

Parsing and Serialization

Document Operations

Internal

package quill

Install

Dune Dependency

Authors

Maintainers

Sources

doc/quill.markdown/Quill_markdown/index.html

Module Quill_markdownSource

Constructors

Parsing and Serialization

Document Operations

Internal

Module `Quill_markdown`Source