package yocaml_markdown

  1. Overview
  2. Docs
package yocaml_markdown
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Yocaml_markdown.PipelineSource

Task to deal with Pipelines.

Sourceval make : ?strict:bool -> ?heading_auto_ids:bool -> ?highlight:(Cmarkit.Doc.t -> Cmarkit.Doc.t) -> ?safe:bool -> unit -> (string, string) Yocaml.Task.t

Convert a Markdown string to an HTML String.

Sourceval to_doc : ?strict:bool -> ?heading_auto_ids:bool -> ?highlight:(Cmarkit.Doc.t -> Cmarkit.Doc.t) -> unit -> (string, Cmarkit.Doc.t) Yocaml.Task.t

A Task for converting a string into a Cmarkit document.

Sourceval table_of_contents : ?traverse_table:((string * string) Yocaml.Markup.Toc.t -> string option) -> unit -> (Cmarkit.Doc.t, string option) Yocaml.Task.t

Compute the table of content of a given document.

Sourceval with_table_of_contents : ?traverse_table:((string * string) Yocaml.Markup.Toc.t -> string option) -> unit -> (Cmarkit.Doc.t, string option * Cmarkit.Doc.t) Yocaml.Task.t

Compute the table of contents of a given document and collapse the result.

Sourceval table_of_contents_metadata : ?traverse_table:((string * string) Yocaml.Markup.Toc.t -> string option) -> unit -> ('a * Cmarkit.Doc.t, ('a * string option) * Cmarkit.Doc.t) Yocaml.Task.t

Deal with table of contents at the metadata level.

Sourceval to_html : ?safe:bool -> unit -> (Cmarkit.Doc.t, string) Yocaml.Task.t

A Task to convert a document to HTML.

Sourcemodule With_metadata : sig ... end