package mdx

  1. Overview
  2. Docs
Executable code blocks inside markdown files

Install

Dune Dependency

Authors

Maintainers

Sources

mdx-1.5.0.tbz
sha256=b68fea7235aa95a407bccea76352a8a32dee0441a72f701f3aa19d4f1cbd853c
sha512=2853e68f2e91ea36f3f22459ff1cd512237e6380163434e2bd59eee1946d166119663aaafb5acd672cbf285d9f191aee2e39fa5f587cbd41020eeae8815887cf

doc/mdx.top/Mdx_top/Part/index.html

Module Mdx_top.Part

type file

The type for files.

val read : string -> file

read f is the file f. It's a costly operations, better to be done once.

val contents : file -> string

contents f is f contents.

val find : file -> part:string option -> string list option

find f ~part returns the lines of the part part in the file f. Return None if f does not contain the part part.

val replace : file -> part:string option -> lines:string list -> file

replace ~file ~part ~lines returns the lines of the file file where the lines of part part have been replaced by lines. If part does not occur in the file, a new part is added at the end.

OCaml

Innovation. Community. Security.