package mdx

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Lines
Document

mdx
- Mdx
  - Block
    
    Header
  - Compat
    
    Char
    
    Filename
    
    Lexer
    
    List
    
    String
    
    Warnings
  - Cram
  - Dep
  - Deprecated
  - Document
  - Label
    
    Relation
  - Lexer_mdx
  - Library
    
    Set
  - Mli_parser
    
    Code_block
  - Ocaml_delimiter
  - Ocaml_env
    
    Set
  - Output
  - Part
  - Prelude
  - Stable_printer
    
    Location
  - Syntax
  - Toplevel
  - Util
    
    Array
    
    Csexp
    
    File
    
    List
    
    Option
    
    Process
    
    Result
    
    Infix
    
    List
    
    Sexp
    
    String
mdx.test
- Mdx_test
  - Package
  - Predicate
mdx.top
- Mdx_top

Legend:
Library
Module
Module type
Parameter
Class
Class type

Lines

type syntax = Syntax.t =

| Normal
| Cram
| Mli

type line =

| Section of int * string
| Text of string
| Block of Block.t

The type for the lines of a markdown or cram file.

val pp_line : ?syntax:syntax -> line Fmt.t

pp_line is the pretty-printer for markdown or cram lines.

Document

type t = line list

The type for mdx documents.

val pp : ?syntax:syntax -> t Fmt.t

pp is the pretty printer for mdx documents. Should be idempotent with of_string.

val to_string : t -> string

to_string t converts the document t to a string.

val envs : t -> Ocaml_env.Set.t