Module `Admonition_extension`Source

Admonition extension for odoc.

Provides styled callout blocks for documentation:

@admonition or @admonition.note - Informational notes
@admonition.warning - Warning messages
@admonition.tip - Helpful tips
@admonition.important - Important information

Sourceval prefix : string

Sourceval admonition_css : string

CSS styles for admonitions - registered as a support file

Sourcetype admonition_type =

| Note
| Warning
| Tip
| Important

Map tag variants to admonition types

Sourceval parse_type : string -> Admonition_extension.admonition_type

Sourceval type_to_class : Admonition_extension.admonition_type -> string

Sourceval type_to_label : Admonition_extension.admonition_type -> string

Source

val content_to_blocks : 
  Odoc_document.Comment.Comment.nestable_block_element
    Odoc_document.Comment.Comment.with_location
    list ->
  Odoc_document.Types.Block.one list

Convert comment content to Block.t, preserving references and formatting

Source

val to_document : 
  tag:string ->
  Odoc_document.Comment.Comment.nestable_block_element
    Odoc_document.Comment.Comment.with_location
    list ->
  Odoc_extension_api.extension_output

Document phase - wrap content in styled admonition block

Module Admonition_extensionSource

Module `Admonition_extension`Source