package yocaml_markdown

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Document
Pipeline

The recommended plugin for processing Markdown documents (based on Cmarkit)

Install

dune-project

Dependency

github.com Readme Changelog Edit opam file Versions (7)

Authors

T

The XHTMLBoy <xhtmlboi@gmail.com>

Maintainers

T

The XHTMLBoy <xhtmlboi@gmail.com>

Sources

yocaml-2.7.0.tbz

sha256=89a74bd5cb37e580e45e4ed3d43b07b2cca5af9ab7f98966c48fe9730dc4af2e

sha512=ae77555570320c28c47d748e75056ccc44bb43cddf6fef70e8b556254fd809d67b915b313bd1833c28581db1fdeefbe34e81d5548744d6ecabe466ee1ef6284c

doc/yocaml_markdown/Yocaml_markdown/index.html

Module `Yocaml_markdown`Source

The recommended plugin for converting Markdown documents. It relies on the use of different packets to ensure different levels of conversion:

https://ocaml.org/p/cmarkit/latest
https://ocaml.org/p/hilite/latest for highlighting

Source

val from_string_to_html : 
  ?strict:bool ->
  ?heading_auto_ids:bool ->
  ?highlight:(Cmarkit.Doc.t -> Cmarkit.Doc.t) ->
  ?safe:bool ->
  string ->
  string

A shortcut to directly convert a Makrdown string into an HTML string.

Document

Allows you to compose directly with Cmarkit documents.

Sourcemodule Doc : sig ... end

Features related to direct document processing Cmarkit.

Pipeline

Concrete pipelines.

Sourcemodule Pipeline : sig ... end

Task to deal with Pipelines.