FSharp.Formatting


MarkdownParagraph Type

A paragraph represents a (possibly) multi-line element of a Markdown document. Paragraphs are headings, inline paragraphs, code blocks, lists, quotations, tables and also embedded LaTeX blocks.

Union cases

Union case Description

CodeBlock(code, executionCount, fence, language, ignoredLine, range)

Full Usage: CodeBlock(code, executionCount, fence, language, ignoredLine, range)

Parameters:
    code : string
    executionCount : int option
    fence : string option
    language : string
    ignoredLine : string
    range : MarkdownRange option

A code block, whether fenced or via indentation

code : string
executionCount : int option
fence : string option
language : string
ignoredLine : string
range : MarkdownRange option

EmbedParagraphs(customParagraphs, range)

Full Usage: EmbedParagraphs(customParagraphs, range)

Parameters:

A special addition for computing paragraphs

customParagraphs : MarkdownEmbedParagraphs
range : MarkdownRange option

Heading(size, body, range)

Full Usage: Heading(size, body, range)

Parameters:
size : int
body : MarkdownSpans
range : MarkdownRange option

HorizontalRule(character, range)

Full Usage: HorizontalRule(character, range)

Parameters:

A Markdown Horizontal rule

character : char
range : MarkdownRange option

InlineHtmlBlock(code, executionCount, range)

Full Usage: InlineHtmlBlock(code, executionCount, range)

Parameters:
    code : string
    executionCount : int option
    range : MarkdownRange option

A HTML block

code : string
executionCount : int option
range : MarkdownRange option

LatexBlock(env, body, range)

Full Usage: LatexBlock(env, body, range)

Parameters:

A Markdown Latex block

env : string
body : string list
range : MarkdownRange option

ListBlock(kind, items, range)

Full Usage: ListBlock(kind, items, range)

Parameters:

A Markdown List block

kind : MarkdownListKind
items : MarkdownParagraphs list
range : MarkdownRange option

OtherBlock(lines, range)

Full Usage: OtherBlock(lines, range)

Parameters:

Represents a block of markdown produced when parsing of code or tables or quoted blocks is suppressed

lines : (string * MarkdownRange) list
range : MarkdownRange option

OutputBlock(output, kind, executionCount)

Full Usage: OutputBlock(output, kind, executionCount)

Parameters:
    output : string
    kind : string
    executionCount : int option

A special addition for inserted outputs

output : string
kind : string
executionCount : int option

Paragraph(body, range)

Full Usage: Paragraph(body, range)

Parameters:
body : MarkdownSpans
range : MarkdownRange option

QuotedBlock(paragraphs, range)

Full Usage: QuotedBlock(paragraphs, range)

Parameters:

A Markdown Quote block

paragraphs : MarkdownParagraphs
range : MarkdownRange option

Span(body, range)

Full Usage: Span(body, range)

Parameters:

A Markdown Span block

body : MarkdownSpans
range : MarkdownRange option

TableBlock(headers, alignments, rows, range)

Full Usage: TableBlock(headers, alignments, rows, range)

Parameters:

A Markdown Table

headers : MarkdownTableRow option
alignments : MarkdownColumnAlignment list
rows : MarkdownTableRow list
range : MarkdownRange option

YamlFrontmatter(yaml, range)

Full Usage: YamlFrontmatter(yaml, range)

Parameters:

A special addition for YAML-style frontmatter

yaml : string list
range : MarkdownRange option