package mdx

You can search for identifiers within the package.

in-package search v0.2.0

Executable code blocks inside markdown files

Install

dune-project

Dependency

github.com Readme Changelog ISC License Edit opam file Versions (21)

Authors

T

Thomas Gazagnaire <thomas@gazagnaire.org>

Maintainers

T

Thomas Gazagnaire <thomas@gazagnaire.org>

Sources

mdx-2.7.0.tbz

sha256=e2fdaeb7e05d173ac4b8a0ed3c55da655772fef9b3ba6478f794bfdfacb7265f

sha512=261d731b32e2faa1f3db54fbe463a03b80a12b56f218a5786980f93e80b93bca8b46a85bf6bacb3cc45e2d5bf94a29003677ae7f73dd6fc0164ca5a88337c697

doc/mdx.top/Mdx_top/index.html

Module `Mdx_top`Source

Toplevel logic for mdx.

Sourcetype t

The type for configuration values.

Sourcetype directive =

| Directory of string
| Load of string
(*
The type for toplevel directives
*)

Source

val init : 
  verbose:bool ->
  silent:bool ->
  verbose_findlib:bool ->
  directives:directive list ->
  packages:string list ->
  predicates:string list ->
  unit ->
  t

init () is a new configuration value.

Sourceval eval : t -> string list -> (string list, string list) result

eval t p evaluates the toplevel phrase p (possibly spawning on mulitple lines) with the configuration value t.

Sourceval in_env : Mdx.Ocaml_env.t -> (unit -> 'a) -> 'a

Sourceval skip_reason : t -> string option

skip_reason t returns the reason passed to mdx_skip, or None if that hasn't been called yet.

Sourceval clear_skip : t -> unit

clear_skip t clears the skip state, so that skip_reason t returns None again.