package cmarkit

You can search for identifiers within the package.

in-package search v0.2.0

package cmarkit

cmarkit
- Cmarkit
  - Block
    
    Blank_line
    
    Block_quote
    
    Code_block
    
    Footnote
    
    Heading
    
    Html_block
    
    List'
    
    List_item
    
    Paragraph
    
    Table
    
    Thematic_break
  - Block_line
  - Doc
  - Folder
  - Inline
    
    Autolink
    
    Break
    
    Code_span
    
    Emphasis
    
    Link
    
    Math_span
    
    Raw_html
    
    Strikethrough
    
    Text
  - Label
    
    Map
  - Layout
  - Link_definition
  - Mapper
  - Meta
  - Textloc
- Cmarkit_commonmark
  - Char_set
- Cmarkit_html
- Cmarkit_latex
- Cmarkit_renderer
  - Context
    
    State

Legend:
Library
Module
Module type
Parameter
Class
Class type

Headings.

type atx_layout = {

indent : Layout.indent;
(*
Indent to '#'.
*)
after_opening : Layout.blanks;
(*
Blanks after '#'.
*)
closing : Layout.string;
(*
Closing sequence of '#' and blanks.
*)

}

The type for ATX heading layout.

type setext_layout = {

leading_indent : Layout.indent;
(*
Of heading first line.
*)
trailing_blanks : Layout.blanks;
(*
Of heading last line.
*)
underline_indent : Layout.indent;
(*
Indentation of underline.
*)
underline_count : Layout.count node;
(*
Underline char count.
*)
underline_blanks : Layout.blanks;
(*
Underline trailing blanks.
*)

}

The type for setext heading layout.

type layout = [

| `Atx of atx_layout
| `Setext of setext_layout

]

The type for heading layouts.

type id = [

| `Auto of string
(*
Automatically derived.
*)
| `Id of string
(*
Explicitely specified in another way.
*)

]

The type for heading identifiers. This notion does not exist in CommonMark.

type t

The type for ATX and Setext headings.

val make : ?id:id -> ?layout:layout -> level:int -> Inline.t -> t

make ~level text is a heading with given parameters. layout defaults to `Atx so you should make sure text has no breaks. level is clamped to 1-6 or 1-2 depending on layout. id is an identifier for the heading.

val layout : t -> layout

layout h is the layout of h.

val level : t -> int

level h is the level of h, from 1 to 6.

val inline : t -> Inline.t

inline h is the contents of the heading.

val id : t -> id option

id h is the heading identifier (if any). Can be automatically derived at parse time from the heading inline if heading_auto_ids:true. Can also be derived later via Inline.id.