MarkdownPatterns (FSharp.Formatting) | FSharp.Formatting

FSharp.Formatting

MarkdownPatterns Module

Namespace: FSharp.Formatting.Markdown
Assembly: FSharp.Formatting.Markdown.dll

This module provides an easy way of processing Markdown documents. It lets you decompose documents into leafs and nodes with nested paragraphs.

Types

Type	Description
ParagraphLeafInfo	Carries the identity of a leaf paragraph (no children)
ParagraphNestedInfo	Carries the identity of a paragraph that contains nested paragraph lists
ParagraphSpansInfo	Carries the identity of a paragraph that itself contains inline spans
SpanLeafInfo	Carries the identity of a leaf span (one with no child spans)
SpanNodeInfo	Carries the identity of a node span (one with child spans)

Functions and values

Function or value	Description
`ParagraphLeaf arg1` Full Usage: `ParagraphLeaf arg1` Parameters: arg0 : `ParagraphLeafInfo` Returns: `MarkdownParagraph`	Reconstructs a leaf paragraph from its tag arg0 : `ParagraphLeafInfo` Returns: `MarkdownParagraph`
`ParagraphNested (arg1, pars)` Full Usage: `ParagraphNested (arg1, pars)` Parameters: arg0 : `ParagraphNestedInfo` pars : `MarkdownParagraphs list` Returns: `MarkdownParagraph`	Reconstructs a nested-paragraph container with an updated flat list of child paragraphs arg0 : `ParagraphNestedInfo` pars : `MarkdownParagraphs list` Returns: `MarkdownParagraph`
`ParagraphSpans (arg1, spans)` Full Usage: `ParagraphSpans (arg1, spans)` Parameters: arg0 : `ParagraphSpansInfo` spans : `MarkdownSpans` Returns: `MarkdownParagraph`	Reconstructs a spans-container paragraph with an updated span list arg0 : `ParagraphSpansInfo` spans : `MarkdownSpans` Returns: `MarkdownParagraph`
`SpanLeaf arg1` Full Usage: `SpanLeaf arg1` Parameters: arg0 : `SpanLeafInfo` Returns: `MarkdownSpan`	Reconstructs a leaf span from its tag arg0 : `SpanLeafInfo` Returns: `MarkdownSpan`
`SpanNode (arg1, spans)` Full Usage: `SpanNode (arg1, spans)` Parameters: arg0 : `SpanNodeInfo` spans : `MarkdownSpans` Returns: `MarkdownSpan`	Reconstructs a node span from its tag and a (possibly updated) child span list arg0 : `SpanNodeInfo` spans : `MarkdownSpans` Returns: `MarkdownSpan`

Active patterns

Active pattern	Description
`(\|ParagraphLeaf\|ParagraphNested\|ParagraphSpans\|) par` Full Usage: `(\|ParagraphLeaf\|ParagraphNested\|ParagraphSpans\|) par` Parameters: par : `MarkdownParagraph` Returns: `Choice<ParagraphLeafInfo, (ParagraphNestedInfo * MarkdownParagraphs list), (ParagraphSpansInfo * MarkdownSpans)>`	Active pattern that classifies a as spans-container, leaf, or nested-paragraphs container par : `MarkdownParagraph` Returns: `Choice<ParagraphLeafInfo, (ParagraphNestedInfo * MarkdownParagraphs list), (ParagraphSpansInfo * MarkdownSpans)>`
`(\|SpanLeaf\|SpanNode\|) span` Full Usage: `(\|SpanLeaf\|SpanNode\|) span` Parameters: span : `MarkdownSpan` Returns: `Choice<SpanLeafInfo, (SpanNodeInfo * MarkdownSpans)>`	Active pattern that classifies a as either a leaf (no children) or a node (with children) span : `MarkdownSpan` Returns: `Choice<SpanLeafInfo, (SpanNodeInfo * MarkdownSpans)>`