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-3.0.0.tbz

sha256=c5237c5f345f76c829fd9f4ec5fcd05051e6f4372b24ecf798a48c2649ce9a0e

sha512=babeab686e031160882b739f07773bf1a2ae94a10de8992a4d812b35a487a353c2d3d915ac17fe74b7961570984c62d022c9108aa72562b5d81f93829ef62576

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.