pandoc 0.1.0 · OCaml Package

Library to write pandoc filters.

Types for pandoc

type attr = string * string list * (string * string) list

Attributes: identifier, classes, key/values.

type target = string * string

Target of a link: url and title.

type list_number_style =

| Decimal

type list_number_delim =

| Period

type list_attributes = int * list_number_style * list_number_delim

type math_type =

| DisplayMath
| InlineMath

type quote_type =

| DoubleQuote
| SingleQuote

type format = string

Format for raw blocks.

type inline =

| Code of attr * string
| Image of attr * inline list * target
| Link of attr * inline list * target
| Quoted of quote_type * inline list
| RawInline of string * string
| Space
| Str of string
| UnhandledInline of Yojson.Basic.t

Inline elements.

and block =

| BulletList of block list list
| CodeBlock of attr * string
| OrderedList of list_attributes * block list list
| Para of inline list
| Plain of inline list
| RawBlock of format * string
| UnhandledBlock of Yojson.Basic.t

Block elements.

type t = {

api_version : int list;
meta : Yojson.Basic.t;
blocks : block list;

}

JSON representation of a pandoc file.

Reading and writing

val of_json : Yojson.Basic.t -> t

Internal representation from JSON representation.

val to_json : t -> Yojson.Basic.t

JSON representation from internal representation.

val of_md_file : string -> t

Construct representation of a markdown file.

Mapping functions

val map : 
  ?block:(block -> block list option) ->
  ?inline:(inline -> inline list option) ->
  t ->
  t

General mapping function which maps a function on blocks and a function on inlines. If the functions return None the mapping is further recursed into.

val map_inlines : (inline list -> inline list) -> t -> t

Map a function to every list of inlines.

val map_blocks : (block -> block list option) -> t -> t

Map a function to every block. If the function returns None then the block is further recursed into.

val map_top_blocks : (block -> block list) -> t -> t

Map a function to every block at toplevel.

package pandoc

Types for pandoc

Reading and writing

Mapping functions