package toc

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

TOC library.

val expand : ?depth:int -> Omd.doc -> Omd.doc option

Replace toc in Markdown files by the result of Omd.toc

val to_string : Omd.doc -> string

TODO: use upstream Omd.to_markdown

type t

The type for table of contents.

val v : ?depth:int -> ?add_links:bool -> Omd.doc -> t

v md is md's table of contents.

val pp : t Fmt.t

pp is the pretty-printer for table of contents.

OCaml

Innovation. Community. Security.