Logo FSharp.Formatting

Dsl Module

Concise F# DSL operators for constructing MarkdownParagraph and MarkdownSpan values. Useful for building Markdown ASTs programmatically without specifying range information.

Functions and values

Function or value Description

!!value

Full Usage: !!value

Parameters:
    value : string

Returns: MarkdownSpan

Creates a literal (plain text) inline span

value : string
Returns: MarkdownSpan

``#####`` value

Full Usage: ``#####`` value

Parameters:
Returns: MarkdownParagraph

Creates an H5 heading paragraph

value : MarkdownSpans
Returns: MarkdownParagraph

``####`` value

Full Usage: ``####`` value

Parameters:
Returns: MarkdownParagraph

Creates an H4 heading paragraph

value : MarkdownSpans
Returns: MarkdownParagraph

``###`` value

Full Usage: ``###`` value

Parameters:
Returns: MarkdownParagraph

Creates an H3 heading paragraph

value : MarkdownSpans
Returns: MarkdownParagraph

``##`` value

Full Usage: ``##`` value

Parameters:
Returns: MarkdownParagraph

Creates an H2 heading paragraph

value : MarkdownSpans
Returns: MarkdownParagraph

``#`` value

Full Usage: ``#`` value

Parameters:
Returns: MarkdownParagraph

Creates an H1 heading paragraph

value : MarkdownSpans
Returns: MarkdownParagraph

img body link

Full Usage: img body link

Parameters:
    body : string
    link : string

Returns: MarkdownSpan

Creates a direct image span

body : string
link : string
Returns: MarkdownSpan

link content url

Full Usage: link content url

Parameters:
Returns: MarkdownSpan

Creates a direct hyperlink span

content : MarkdownSpans
url : string
Returns: MarkdownSpan

ol value

Full Usage: ol value

Parameters:
Returns: MarkdownParagraph

Creates an ordered list block

value : MarkdownParagraphs list
Returns: MarkdownParagraph

p value

Full Usage: p value

Parameters:
Returns: MarkdownParagraph

Creates a paragraph block

value : MarkdownSpans
Returns: MarkdownParagraph

span value

Full Usage: span value

Parameters:
Returns: MarkdownParagraph

Creates a span block

value : MarkdownSpans
Returns: MarkdownParagraph

strong value

Full Usage: strong value

Parameters:
Returns: MarkdownSpan

Creates a strong (bold) inline span

value : MarkdownSpans
Returns: MarkdownSpan

table headers alignments rows

Full Usage: table headers alignments rows

Parameters:
Returns: MarkdownParagraph

Creates a table block; an empty header list is treated as no header row

headers : MarkdownParagraphs list
alignments : MarkdownColumnAlignment list
rows : MarkdownTableRow list
Returns: MarkdownParagraph

ul value

Full Usage: ul value

Parameters:
Returns: MarkdownParagraph

Creates an unordered list block

value : MarkdownParagraphs list
Returns: MarkdownParagraph

Type something to start searching.