FSharp.Formatting


FSharp.Formatting.Literate Namespace

Functionality to support literate programming for F# scripts

Type/Module Description

Literate

This type provides three simple methods for calling the literate programming tool. The ConvertMarkdownFile and ConvertScriptFile methods process a single Markdown document and F# script, respectively. The ConvertDirectory method handles an entire directory tree (looking for *.fsx and *.md files).

LiterateCodeOptions

Additional properties of a literate code snippet, embedded in a LiterateParagraph.LiterateCode. The properties specify how should a snippet be evaluated and formatted.

LiterateCodeVisibility

Specifies visibility of a code snippet.

LiterateDocument

Representation of a literate document - the representation of Paragraphs uses an F# discriminated union type and so is best used from F#.

LiterateParagraph

Extends MarkdownParagrap using the MarkdownEmbedParagraphs case with additional kinds of paragraphs that can appear in literate F# scripts (such as various special commands to embed output of a snippet etc.)

LiterateParagraphOptions

Specifies the options for a literate paragraph

LiterateSource

Represents the source of a literate document.

MarkdownPatterns

Provides active patterns for extracting LiterateParagraph values from Markdown documents.

OutputKind

Defines the possible output types from literate script (HTML, Latex, Pynb)