⚠️ Oops! This page doesn't appear to define a type called _.
Show navigation
Search
Home Writing Documentation Interactive Code Snippets
Page Contents
Omd_backend code_stylist default_language html_of_md headers_of_md html_and_headers_of_md escape_markdown_characters text_of_md markdown_of_md sexpr_of_md
Package modules
CliToInput InputToModel CompilePackage ModelToOutput State
Other modules
Ast Comment Error Helpers Lang Location_ Odoc_lexer Parse_error Parser_ Paths Paths_types Root Semantics Syntax Token Html_characters Omd Omd_backend Omd_html Omd_lexer Omd_parser Omd_representation Omd_types Omd_utils Omd_xtxt CompileCode Markdown MarkdownOfOCamldoc ParseConfig ProcessCode Search Tests CmtFindDocItems CmtFindStamps PrepareUtils Typing Descartes ElasticRaw MakeIndex CodeHighlight CodeSnippets Docs DocsTemplate GenerateDoc Pretty PrintType Sidebar Template SearchScript Commands Files Infix SerializeBinary CompileCode Markdown MarkdownOfOCamldoc ParseConfig ProcessCode Search Tests CmtFindDocItems CmtFindStamps PrepareUtils Typing Descartes ElasticRaw MakeIndex CodeHighlight CodeSnippets Docs DocsTemplate GenerateDoc Pretty PrintType Sidebar Template SearchScript Commands Files Infix SerializeBinary CmtFindDocItems CmtFindStamps PrepareUtils Typing Descartes ElasticRaw MakeIndex CodeHighlight CodeSnippets Docs DocsTemplate GenerateDoc Pretty PrintType Sidebar Template SearchScript Commands Files Infix SerializeBinary
Edit

Omd_backend

This module does not have a toplevel documentation block.

type code_stylist = (~lang: string, string) => string

Function that takes a language name and some code and returns that code with style.

let default_language: Pervasives.ref(string)

default language for code blocks can be set to any name, by default it is the empty string

let html_of_md: ( ~?override: option(element => option(string)), ~?pindent: option(bool), ~?nl2br: option(bool), ~?cs: option(code_stylist), Omd_representation.t ) => string

html_of_md md returns a string containing the HTML version of md. Note that md uses the internal representation of Markdown.

The optional parameter override allows to override an precise behaviour for a constructor of Omd_representation.element, as in the following example:

let customized_to_html = Omd.html_of_md ~override:(function | Url (href,s,title) -> Some("<a href='" ^ (Omd_utils.htmlentities ~md:true href) ^ "'" ^ (if title <> "" then " title='" ^ (Omd_utils.htmlentities ~md:true title) ^ "'" else "") ^ ">" ^ Omd_backend.html_of_md s ^ " target='_blank'</a>") | _ -> None)

let headers_of_md: ( ~?remove_header_links: option(bool), Omd_representation.t ) => list((element, string, string))

headers_of_md md returns a list of 3-tuples; in each of them the first element is the header (e.g., H1(foo)), the second is the HTML id (as produced by html_of_md), and the third element is the HTML version of foo. The third elements of those 3-tuples exist because if you use html_and_headers_of_md, then you have the guarantee that the HTML version of foo is the same for both the headers and the HTML version of md. If remove_header_links, then remove links inside headers (h1, h2, ...). Default value of remove_header_links: cf. html_and_headers_of_md.

let html_and_headers_of_md: ( ~?remove_header_links: option(bool), ~?override: option(element => option(string)), ~?pindent: option(bool), ~?nl2br: option(bool), ~?cs: option(code_stylist), Omd_representation.t ) => (string, list((element, elt, string)))

html_and_headers_of_md md is the same as (html_of_md md, headers_of_md md) except that it's two times faster. If you need both headers and html, don't use html_of_md and headers_of_md but this function instead. If remove_header_links, then remove links inside headers (h1, h2, ...). Default value of remove_header_links: false.

let escape_markdown_characters: string => string

escape_markdown_characters s returns a string where markdown-significant characters in s have been backslash-escaped. Note that escape_markdown_characters takes a "raw" string, therefore it doesn't have the whole context in which the string appears, thus the escaping cannot really be minimal. However the implementation tries to minimalise the extra escaping.

let text_of_md: Omd_representation.t => string

text_of_md md is basically the same as html_of_md md but without the HTML tags in the output.

let markdown_of_md: Omd_representation.t => string

markdown_of_md md is basically the same as html_of_md md but with the output in Markdown syntax rather than HTML.

let sexpr_of_md: Omd_representation.t => string

sexpr_of_md md is basically the same as html_of_md md but with the output in s-expressions rather than HTML. This is mainly used for debugging.