Markdown (FSharp.Formatting)

Markdown Type

Namespace: FSharp.Formatting.Markdown
Assembly: FSharp.Formatting.Markdown.dll
Base Type: obj

Static class that provides methods for formatting and transforming Markdown documents.

Static members

Static member	Description
`Markdown.Parse(text, ?newline, ?parseOptions)` Full Usage: `Markdown.Parse(text, ?newline, ?parseOptions)` Parameters: text : `string` ?newline : `string` ?parseOptions : `MarkdownParseOptions` Returns: `MarkdownDocument`	Parse the specified text into a MarkdownDocument. Line breaks in the inline HTML (etc.) will be stored using the specified string. text : `string` ?newline : `string` ?parseOptions : `MarkdownParseOptions` Returns: `MarkdownDocument`
`Markdown.ToFsx(doc, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)` Full Usage: `Markdown.ToFsx(doc, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)` Parameters: doc : `MarkdownDocument` ?newline : `string` ?substitutions : `(ParamKey * string) list` ?crefResolver : `string -> (string * string) option` ?mdlinkResolver : `string -> string option` Returns: `string`	Transform the provided MarkdownDocument into Fsx and return the result as a string. doc : `MarkdownDocument` ?newline : `string` ?substitutions : `(ParamKey * string) list` ?crefResolver : `string -> (string * string) option` ?mdlinkResolver : `string -> string option` Returns: `string`
`Markdown.ToHtml(markdownText, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)` Full Usage: `Markdown.ToHtml(markdownText, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)` Parameters: markdownText : `string` ?newline : `string` ?substitutions : `(ParamKey * string) list` ?crefResolver : `string -> (string * string) option` ?mdlinkResolver : `string -> string option` Returns: `string`	Transform Markdown document into HTML format. The result will be returned as a string. markdownText : `string` ?newline : `string` ?substitutions : `(ParamKey * string) list` ?crefResolver : `string -> (string * string) option` ?mdlinkResolver : `string -> string option` Returns: `string`
`Markdown.ToHtml(doc, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)` Full Usage: `Markdown.ToHtml(doc, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)` Parameters: doc : `MarkdownDocument` ?newline : `string` ?substitutions : `(ParamKey * string) list` ?crefResolver : `string -> (string * string) option` ?mdlinkResolver : `string -> string option` Returns: `string`	Transform the provided MarkdownDocument into HTML format and return the result as a string. doc : `MarkdownDocument` ?newline : `string` ?substitutions : `(ParamKey * string) list` ?crefResolver : `string -> (string * string) option` ?mdlinkResolver : `string -> string option` Returns: `string`
`Markdown.ToLatex(markdownText, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver, ?lineNumbers)` Full Usage: `Markdown.ToLatex(markdownText, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver, ?lineNumbers)` Parameters: markdownText : `string` ?newline : `string` ?substitutions : `(ParamKey * string) list` ?crefResolver : `string -> (string * string) option` ?mdlinkResolver : `string -> string option` ?lineNumbers : `bool` Returns: `string`	Transform Markdown text into LaTeX format. The result will be returned as a string. markdownText : `string` ?newline : `string` ?substitutions : `(ParamKey * string) list` ?crefResolver : `string -> (string * string) option` ?mdlinkResolver : `string -> string option` ?lineNumbers : `bool` Returns: `string`
`Markdown.ToLatex(doc, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver, ?lineNumbers)` Full Usage: `Markdown.ToLatex(doc, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver, ?lineNumbers)` Parameters: doc : `MarkdownDocument` ?newline : `string` ?substitutions : `(ParamKey * string) list` ?crefResolver : `string -> (string * string) option` ?mdlinkResolver : `string -> string option` ?lineNumbers : `bool` Returns: `string`	Transform the provided MarkdownDocument into LaTeX format and return the result as a string. doc : `MarkdownDocument` ?newline : `string` ?substitutions : `(ParamKey * string) list` ?crefResolver : `string -> (string * string) option` ?mdlinkResolver : `string -> string option` ?lineNumbers : `bool` Returns: `string`
`Markdown.ToMd(doc, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)` Full Usage: `Markdown.ToMd(doc, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)` Parameters: doc : `MarkdownDocument` ?newline : `string` ?substitutions : `(ParamKey * string) list` ?crefResolver : `string -> (string * string) option` ?mdlinkResolver : `string -> string option` Returns: `string`	Transform the provided MarkdownDocument into Markdown and return the result as a string. doc : `MarkdownDocument` ?newline : `string` ?substitutions : `(ParamKey * string) list` ?crefResolver : `string -> (string * string) option` ?mdlinkResolver : `string -> string option` Returns: `string`
`Markdown.ToPynb(doc, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)` Full Usage: `Markdown.ToPynb(doc, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)` Parameters: doc : `MarkdownDocument` ?newline : `string` ?substitutions : `(ParamKey * string) list` ?crefResolver : `string -> (string * string) option` ?mdlinkResolver : `string -> string option` Returns: `string`	Transform the provided MarkdownDocument into Pynb and return the result as a string. doc : `MarkdownDocument` ?newline : `string` ?substitutions : `(ParamKey * string) list` ?crefResolver : `string -> (string * string) option` ?mdlinkResolver : `string -> string option` Returns: `string`
`Markdown.WriteHtml(markdownText, writer, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)` Full Usage: `Markdown.WriteHtml(markdownText, writer, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)` Parameters: markdownText : `string` writer : `TextWriter` ?newline : `string` ?substitutions : `(ParamKey * string) list` ?crefResolver : `string -> (string * string) option` ?mdlinkResolver : `string -> string option`	Transform Markdown text into HTML format. The result will be written to the provided TextWriter. markdownText : `string` writer : `TextWriter` ?newline : `string` ?substitutions : `(ParamKey * string) list` ?crefResolver : `string -> (string * string) option` ?mdlinkResolver : `string -> string option`
`Markdown.WriteHtml(doc, writer, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)` Full Usage: `Markdown.WriteHtml(doc, writer, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)` Parameters: doc : `MarkdownDocument` writer : `TextWriter` ?newline : `string` ?substitutions : `(ParamKey * string) list` ?crefResolver : `string -> (string * string) option` ?mdlinkResolver : `string -> string option`	Transform the provided MarkdownDocument into HTML format and write the result to a given writer. doc : `MarkdownDocument` writer : `TextWriter` ?newline : `string` ?substitutions : `(ParamKey * string) list` ?crefResolver : `string -> (string * string) option` ?mdlinkResolver : `string -> string option`
`Markdown.WriteLatex(markdownText, writer, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)` Full Usage: `Markdown.WriteLatex(markdownText, writer, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)` Parameters: markdownText : `string` writer : `TextWriter` ?newline : `string` ?substitutions : `(ParamKey * string) list` ?crefResolver : `string -> (string * string) option` ?mdlinkResolver : `string -> string option`	Transform Markdown document into LaTeX format. The result will be written to the provided TextWriter. markdownText : `string` writer : `TextWriter` ?newline : `string` ?substitutions : `(ParamKey * string) list` ?crefResolver : `string -> (string * string) option` ?mdlinkResolver : `string -> string option`
`Markdown.WriteLatex(doc, writer, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver, ?lineNumbers)` Full Usage: `Markdown.WriteLatex(doc, writer, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver, ?lineNumbers)` Parameters: doc : `MarkdownDocument` writer : `TextWriter` ?newline : `string` ?substitutions : `(ParamKey * string) list` ?crefResolver : `string -> (string * string) option` ?mdlinkResolver : `string -> string option` ?lineNumbers : `bool`	Transform the provided MarkdownDocument into LaTeX format and write the result to a given writer. doc : `MarkdownDocument` writer : `TextWriter` ?newline : `string` ?substitutions : `(ParamKey * string) list` ?crefResolver : `string -> (string * string) option` ?mdlinkResolver : `string -> string option` ?lineNumbers : `bool`